Headers
Content-Type: application/json
Body
{ "token": "8m2kc5g", "managed-by": "Braintree", "external-id": "abc123", "next-billing-time": "2021-05-17T04:31:33Z", "ends": "2021-05-17T04:31:33Z", "blaize-product": { "id": "one-month-one-off", "label": "One month access", "description": "One month access"}, "transaction-history": [ { "human-readable-amount": "$2.34", "time": "Hello, world!", "currency": "$", "cents": 234, "cycle": "month", "cycleCount": 1, "taxRate": { "taxPercent": 15, "isTaxInclusive": true, "displayName": "VAT", "active": true} } ], "subscription-state": "active", "paid_through_date": "2021-05-17T04:31:33Z", "plan_id": "plan-123", "plan_name": "monthly-plan", "currency_code": "GBP", "pre_discount_price": 50, "billing_frequency_unit": "MONTH", "billing_frequency": 1, "discounts_applied": true, "multiphase_plan": true}
Schema
{ "$schema": "", "type": "object", "properties": { "token": { "type": "string", "description": "The token identifier for this payment method."}, "managed-by": { "type": "string"}, "external-id": { "type": "string", "description": "The ID for this subscription in Braintree."}, "next-billing-time": { "type": "string", "description": "ISO-8601 formatted time at which the subscription will next be billed."}, "ends": { "type": "string", "description": "ISO-8601 formatted time at which the subscription is expected to end."}, "blaize-product": { "type": "object", "properties": { "id": { "type": "string", "description": "Zephr product ID"}, "label": { "type": "string", "description": "Zephr product label"}, "description": { "type": "string", "description": "Description of Zephr product"} }, "description": "The Zephr product associated with this subscription."}, "transaction-history": { "type": "array"}, "subscription-state": { "type": "string", "description": "The subscription state, as acquired from Braintree."}, "paid_through_date": { "type": "string", "description": "ISO-8601 formatted time up to which the subscription has been paid for. This will be `null` if the subscription has not yet been paid for."}, "plan_id": { "type": "string", "description": "The Braintree plan ID"}, "plan_name": { "type": "string", "description": "The Braintree plan name"}, "currency_code": { "type": "string", "description": "The currency of the subscription price."}, "pre_discount_price": { "type": "number", "description": "The subscription price before any discounts are applied."}, "billing_frequency_unit": { "type": "string", "description": "The time unit of the billing frequency, one of: YEAR, MONTH, WEEK, DAY."}, "billing_frequency": { "type": "number", "description": "The frequency at which the subscription is billed, in the units specified by billing_frequency_unit."}, "discounts_applied": { "type": "boolean", "description": "If the subscription has any applied discounts."}, "multiphase_plan": { "type": "boolean", "description": "If the subscription plan has multiple phases."} }, "required": [ "token", "managed-by", "external-id", "next-billing-time", "ends", "blaize-product", "transaction-history", "subscription-state", "plan_id", "plan_name", "currency_code", "pre_discount_price", "billing_frequency_unit", "billing_frequency", "discounts_applied", "multiphase_plan" ]}
