Plans

API Reference

V1

Plans

Plans

Get plan details

client.v1.plans.getDetails(PlanGetDetailsParamsparams, RequestOptionsoptions?): dataPlanDetailPlanGetDetailsResponse

get/v1/planDetails/{plan_id}

List plans

client.v1.plans.list(PlanListParamsquery?, RequestOptionsoptions?): CursorPage<idstringdescriptionstringnamestringcustom_fieldsRecord<string, string>PlanListResponse>

get/v1/plans

List plan charges

client.v1.plans.listCharges(PlanListChargesParamsparams, RequestOptionsoptions?): CursorPage<idstringcharge_typeunioncredit_typeCreditTypeDatacustom_fieldsRecord<string, string>namestringpricesarrayproduct_idstringproduct_namestringquantitynumberstart_periodnumbertier_reset_frequencynumberunit_conversionUnitConversionPlanListChargesResponse>

get/v1/planDetails/{plan_id}/charges

List customers on a plan

client.v1.plans.listCustomers(PlanListCustomersParamsparams, RequestOptionsoptions?): CursorPage<customer_detailsCustomerDetailplan_detailsPlanDetailsPlanListCustomersResponse>

get/v1/planDetails/{plan_id}/customers

Plan Detail

PlanDetail

ShowShow

idstring

formatuuid

custom_fieldsRecord<string, string>

namestring

credit_grantsarray

optional

Array<CreditGrant>

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

optional

Array<Minimum>

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

optional

Array<OverageRate>

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