Plans

API Reference

V1

Plans

Plans

Get plan details

client.V1.Plans.GetDetails(ctx, query) (*DataPlanDetailV1PlanGetDetailsResponse, error)

get/v1/planDetails/{plan_id}

List plans

client.V1.Plans.List(ctx, query) (*CursorPage[IDstringDescriptionstringNamestringCustomFieldsmapV1PlanListResponse], error)

get/v1/plans

List plan charges

client.V1.Plans.ListCharges(ctx, params) (*CursorPage[IDstringChargeTypeV1PlanListChargesResponseChargeTypeCreditTypeCreditTypeDataCustomFieldsmapNamestringPricesarrayProductIDstringProductNamestringQuantityfloat64StartPeriodfloat64TierResetFrequencyfloat64UnitConversionV1PlanListChargesResponseUnitConversionV1PlanListChargesResponse], error)

get/v1/planDetails/{plan_id}/charges

List customers on a plan

client.V1.Plans.ListCustomers(ctx, params) (*CursorPage[CustomerDetailsCustomerDetailPlanDetailsV1PlanListCustomersResponsePlanDetailsV1PlanListCustomersResponse], error)

get/v1/planDetails/{plan_id}/customers

Plan Detail

PlanDetailstruct

ShowShow

IDstring

formatuuid

CustomFieldsmap

map[string, string]

Namestring

CreditGrantsarray

optional

[]PlanDetailCreditGrant

Hide ParametersShow Parameters

AmountGrantedfloat64

AmountGrantedCreditTypeIDstringNamestringCreditTypeData

AmountPaidfloat64

AmountPaidCreditTypeIDstringNamestringCreditTypeData

EffectiveDurationfloat64

Namestring

Prioritystring

SendInvoicebool

Reasonstring

optional

RecurrenceDurationfloat64

optional

RecurrenceIntervalfloat64

optional

Descriptionstring

optional

Minimumsarray

optional

[]PlanDetailMinimum

Hide ParametersShow Parameters

CreditTypeIDstringNamestringCreditTypeData

Namestring

StartPeriodfloat64

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

Valuefloat64

OverageRatesarray

optional

[]PlanDetailOverageRate

Hide ParametersShow Parameters

CreditTypeIDstringNamestringCreditTypeData

FiatCreditTypeIDstringNamestringCreditTypeData

StartPeriodfloat64

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

ToFiatConversionFactorfloat64