Skip to main content
PATCH
/
api
/
v1
/
subscription
/
plans
/
{planId}
Update a plan
curl --request PATCH \
  --url https://payments.oaknetwork.org/api/v1/subscription/plans/{planId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "frequency": 123,
  "price": 123,
  "currency": "<string>",
  "created_by": "<string>",
  "overridden_price": 123,
  "start_time": "2023-12-25",
  "end_time": "2023-12-25",
  "is_auto_renewable": true,
  "allow_amount_override": true,
  "campaign_id": "<string>",
  "campaign_name": "<string>"
}
'
{
  "msg": "plan updated",
  "data": "<string>"
}

Authorizations

Authorization
string
header
required

Merchant authentication token. Obtained via POST /api/v1/merchant/token/grant. Pass as: Authorization: Bearer

Path Parameters

planId
string
required

Body

application/json
name
string
required
description
string
required
frequency
integer
required

Billing frequency in days

price
integer
required

Price amount

currency
string
required
created_by
string
required
overridden_price
integer
start_time
string<date>
end_time
string<date>
is_auto_renewable
boolean
allow_amount_override
boolean
campaign_id
string
campaign_name
string

Response

200 - application/json

Plan updated

msg
string
required

Human-readable message describing the result

Example:

"plan updated"

data
string
required

Plan hash ID