Add a plan to a customer
POST {{baseUrl}}/customers/:customer_id/plans/add
Associate an existing customer with a plan for a specified date range. See the price adjustments documentation for details on the price adjustments.
Request Body
{"plan_id"=>"<uuid>", "starting_on"=>"<dateTime>", "ending_before"=>"<dateTime>", "net_payment_terms_days"=>"<number>", "price_adjustments"=>[{"charge_id"=>"<uuid>", "adjustment_type"=>"fixed", "start_period"=>"<number>", "value"=>"<number>", "quantity"=>"<number>", "tier"=>"<number>"}, {"charge_id"=>"<uuid>", "adjustment_type"=>"fixed", "start_period"=>"<number>", "value"=>"<number>", "quantity"=>"<number>", "tier"=>"<number>"}], "trial_spec"=>{"length_in_days"=>"<number>", "spending_cap"=>{"credit_type_id"=>"<string>", "amount"=>"<number>"}}, "overage_rate_adjustments"=>[{"custom_credit_type_id"=>"<uuid>", "fiat_currency_credit_type_id"=>"<uuid>", "to_fiat_conversion_factor"=>"<number>"}, {"custom_credit_type_id"=>"<uuid>", "fiat_currency_credit_type_id"=>"<uuid>", "to_fiat_conversion_factor"=>"<number>"}]}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
{"data":{"id":"\u003cuuid\u003e"}}