Plans

API Reference

V1

Plans

Plans

Get plan details

v1.plans.get_details(PlanGetDetailsParams**kwargs) -> dataPlanDetailPlanGetDetailsResponse

get/v1/planDetails/{plan_id}

List plans

v1.plans.list(PlanListParams**kwargs) -> SyncCursorPage[idstrdescriptionstrnamestrcustom_fieldsDict[str, str]PlanListResponse]

get/v1/plans

List plan charges

v1.plans.list_charges(PlanListChargesParams**kwargs) -> SyncCursorPage[idstrcharge_typeliteralcredit_typeCreditTypeDatacustom_fieldsDict[str, str]namestrpriceslistproduct_idstrproduct_namestrquantityfloatstart_periodfloattier_reset_frequencyfloatunit_conversionUnitConversionPlanListChargesResponse]

get/v1/planDetails/{plan_id}/charges

List customers on a plan

v1.plans.list_customers(PlanListCustomersParams**kwargs) -> SyncCursorPage[customer_detailsCustomerDetailplan_detailsPlanDetailsPlanListCustomersResponse]

get/v1/planDetails/{plan_id}/customers

Plan Detail

PlanDetailclass

ShowShow

idstr

formatuuid

custom_fieldsDict[str, str]

Dict[str, str]

namestr

credit_grantslist

optional

Optional[List[CreditGrant]]

Hide ParametersShow Parameters

amount_grantedfloat

amount_granted_credit_typeidstrnamestrCreditTypeData

amount_paidfloat

amount_paid_credit_typeidstrnamestrCreditTypeData

effective_durationfloat

namestr

prioritystr

send_invoicebool

reasonstr

optional

recurrence_durationfloat

optional

recurrence_intervalfloat

optional

descriptionstr

optional

minimumslist

optional

Optional[List[Minimum]]

Hide ParametersShow Parameters

credit_typeidstrnamestrCreditTypeData

namestr

start_periodfloat

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

valuefloat

overage_rateslist

optional

Optional[List[OverageRate]]

Hide ParametersShow Parameters

credit_typeidstrnamestrCreditTypeData

fiat_credit_typeidstrnamestrCreditTypeData

start_periodfloat

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

to_fiat_conversion_factorfloat