HIhitpayapp

Update Subscription Plan

Use this API to update the subscription plan, changes made to the plan will not affect current subscription. If you would like to make changes to the current subscriptions use the Update Recurring Billing API.

put/v1/subscription-plan/{plan_id}

Request

  • Base URL
    https://api.hit-pay.com
  • URL
    https://api.hit-pay.com/v1/subscription-plan/{plan_id}
  • Auth
    none required

Path parameters

plan_idstring required

Headers

X-BUSINESS-API-KEYstring required
Example:b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d

Request body

namestring required

Plan name. It's required field

descriptionstring

The description of subscription plan

cycle'weekly' | 'monthly' | 'yearly' | 'custom' | 'save_card' required

Billing frequency (weekly / monthly / yearly / custom / save_card). If cycle = custom then the user has to send the fields cycle_repeat and cycle_frequency

cycle_frequency'day' | 'week' | 'month' | 'year'

[This field is only applicable when cycle = custom] It's the frequency of the cycle [day / week / month / year]

cycle_repeatinteger

[This field is only applicable when cycle = custom] It's the number of times the cycle will repeat.

currencystring
referencestring

Arbitrary reference number that you can map to your internal reference number. This value cannot be edited by the customer

redirect_urlstring

The redirected URL after the payment

start_date_method'sign_up_date' | 'customer_select_date' | 'fixed_date'
fixed_datenumber

it's required if start_date_method = fixed_date

times_to_be_chargednumber

Example request

{
  "currency": "SGD"
}

Response

200

idstring
namestring
descriptionstring
cyclestring
cycle_repeatunknown
cycle_frequencyunknown
currencystring
amountnumber
referencestring
created_atstring
updated_atstring

Example response

{
  "id": "973ee344-6737-4897-9929-edbc9d7bf433",
  "name": "Spotify Premium",
  "description": "Spotify Monthly Subscription",
  "cycle": "monthly",
  "currency": "sgd",
  "amount": 12.9,
  "reference": "spotify_premium_2022",
  "created_at": "2022-09-13T12:34:13",
  "updated_at": "2022-09-13T12:34:13"
}

Changes

No recorded changes to this operation across all 8 revisions of this API.