Sign in

v1

latestOpenAPI 3.0.32026-07-2476126451.9 KB
v1.1

Get subscription

Get subscription details

get/api/v1.4/subscriptions/{subscription_id}/

Path parameters

subscription_idstring required

A unique identifier for subscription.

Response

idstring required
namestring required

Plan name.

descriptionstring required

Plan description.

currencystring required

The currency of the plan represented by a string of alphabetic code from ISO 4217 Currency codes.

amountnumber double required

Plan's base amount to be used in subscription invoices.

one_time_feestring required

One time fee will be added once to the first subscription invoice when subscripting to this plan.

trial_periodinteger nullable required

Number of trial days before the first recurring cycle.

recurrencyinteger required

The interval at which a subscription is charged.

recurrency_unitstring required

The time unit used to define the recurrency. DAY and MONTH are supported

recurring_cyclesinteger nullable required

The total number of payment cycles in the subscription lifetime. if empty the subscription will be charged forever till canceled.

discount_amountstring required

Discount amount applied.

discount_percentagestring decimal nullable required

Discount percentage applied.

discount_cyclesinteger nullable required

How many cycles the discount will be applied to.

is_liveboolean required
createdstring required