Plans

API Reference

V1

Plans

Plans

Get plan details

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

get/v1/planDetails/{plan_id}

List plans

v1.plans.list(**kwargs) -> CursorPage<idStringdescriptionStringnameStringcustom_fieldshashPlanListResponse>

get/v1/plans

List plan charges

v1.plans.list_charges(**kwargs) -> CursorPage<idStringcharge_typeunioncredit_typeCreditTypeDatacustom_fieldshashnameStringpricesarrayproduct_idStringproduct_nameStringquantityFloatstart_periodFloattier_reset_frequencyFloatunit_conversionobjectPlanListChargesResponse>

get/v1/planDetails/{plan_id}/charges

List customers on a plan

v1.plans.list_customers(**kwargs) -> CursorPage<customer_detailsCustomerDetailplan_detailsobjectPlanListCustomersResponse>

get/v1/planDetails/{plan_id}/customers

Plan Detail

PlanDetailclass

ShowShow

idString

formatuuid

custom_fieldshash

Hash[Symbol, String]

nameString

credit_grantsarray

optional

Array[{ amount_granted, amount_granted_credit_type, amount_paid, 8 more}]

Hide ParametersShow Parameters

amount_grantedFloat

amount_granted_credit_typeidStringnameStringCreditTypeData

amount_paidFloat

amount_paid_credit_typeidStringnameStringCreditTypeData

effective_durationFloat

nameString

priorityString

send_invoicebool

reasonString

optional

recurrence_durationFloat

optional

recurrence_intervalFloat

optional

descriptionString

optional

minimumsarray

optional

Array[{ credit_type, name, start_period, value}]

Hide ParametersShow Parameters

credit_typeidStringnameStringCreditTypeData

nameString

start_periodFloat

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

valueFloat

overage_ratesarray

optional

Array[{ credit_type, fiat_credit_type, start_period, to_fiat_conversion_factor}]

Hide ParametersShow Parameters

credit_typeidStringnameStringCreditTypeData

fiat_credit_typeidStringnameStringCreditTypeData

start_periodFloat

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

to_fiat_conversion_factorFloat