Plans

API Reference

V1

Plans

Plans

Get plan details

get/v1/planDetails/{plan_id}

List plans

get/v1/plans

List plan charges

get/v1/planDetails/{plan_id}/charges

List customers on a plan

get/v1/planDetails/{plan_id}/customers

Plan Detail

PlanDetailobject

ShowShow

idstring

formatuuid

custom_fieldsmap

namestring

credit_grantsarray of object

optional

Hide ParametersShow Parameters

amount_grantednumber

amount_granted_credit_typeidstringnamestringCreditTypeData

amount_paidnumber

amount_paid_credit_typeidstringnamestringCreditTypeData

effective_durationnumber

namestring

prioritystring

send_invoiceboolean

reasonstring

optional

recurrence_durationnumber

optional

recurrence_intervalnumber

optional

descriptionstring

optional

minimumsarray of object

optional

Hide ParametersShow Parameters

credit_typeidstringnamestringCreditTypeData

namestring

start_periodnumber

Used in price ramps. Indicates how many billing periods pass before the charge applies.

valuenumber

overage_ratesarray of object

optional

Hide ParametersShow Parameters

credit_typeidstringnamestringCreditTypeData

fiat_credit_typeidstringnamestringCreditTypeData

start_periodnumber

Used in price ramps. Indicates how many billing periods pass before the charge applies.

to_fiat_conversion_factornumber