Subscription Object

attributes id string a unique identifier for the subscription object string the value is always subscription next billing date timestamp the upcoming billing date of the subscription available for subscriptions with status active , past due and trialing cancellation date timestamp the date the subscription was cancelled available for subscriptions with status cancelled resumes at timestamp the date the payment collection of the subscription will be resumed available for subscriptions with status paused completion date timestamp the date the instalment plan was completed available for subscriptions with type instalment payment count integer the total number of payments received for the subscription status string the current status of the subscription gateway subscription id string the unique id of the subscription used by the payment provider type string the possible values are instalment , subscription and recurring invoice gateway string appendix docid\ kfbmx4q3dxjtduqf75yx1 the payment method of the subscription billing cycle string the possible values are day , week , month and year interval integer the billing interval of the subscription currency string the currency of the subscription price integer the cost of the subscription invoice id string the id of the invoice associated with the subscription available for subscriptions with type instalment instalments count integer the total number of payments that have to be collected for this instalment plan available for subscriptions with type instalment lifetime revenue integer the total lifetime revenue generated by the subscription upcoming invoice invoice object docid\ ebk zdbyuq96ennwbv l6 the upcoming invoice of the subscription provided if the subscription the subscription is active or trialing customer object an object containing a few basic information about the customer "customer" { "id" "72b51cc1 613a 4189 a395 d5161b8a16c2", "name" "john", "first name" "john", "last name" "doe", "email" "john\@example com", "locale" "en", "client id" null, "address id" "21d10711 4ed0 4f51 ad58 f7fa72d79d25" } id string the customer id name string the name of the customer last name string the customer's last name email string the customer's email locale string ( appendix docid\ kfbmx4q3dxjtduqf75yx1 ) the preferred language of the customer client id string the id of the associated client (if applicable) products array of objects an array of objects, each corresponding to a billing plan associated with the subscription "products" \[ { "id" "619b5981 c097 4eb8 890b 5166b30880fd", "name" "subscription with trial" } ] id string the id of the product (if applicable) name string the name of the product { "id" "7165b7ea 8be1 4a0f b924 a04f45002e20", "object" "subscription", "next billing date" 1712274818, "cancellation date" null, "completion date" null, "resumes at" null, "customer" { "id" "72b51cc1 613a 4189 a395 d5161b8a16c2", "name" "john", "first name" "john", "last name" "doe", "email" "john\@example com", "locale" "en", "client id" null, "address id" "21d10711 4ed0 4f51 ad58 f7fa72d79d25" }, "products" \[ { "id" "619b5981 c097 4eb8 890b 5166b30880fd", "name" "subscription with trial" } ], "payment count" 1, "status" "active", "gateway subscription id" "sub 1oqlkafufeibdglb6cl6qjgv", "type" "subscription", "gateway" "stripe", "billing cycle" "month", "interval" 1, "currency" "eur", "price" 10000, "lifetime revenue" 10000, "upcoming invoice" { "currency" "eur", "customer information" { "billing information" { "address" "1234 street", "city" "luxer", "country" "us", "custom billing fields" null, "email" "john\@example com", "id" "21d10711 4ed0 4f51 ad58 f7fa72d79d25", "ip" null, "is company" true, "last name" null, "locale" "en", "name" "john", "object" "address", "phone" null, "postcode" "abc1245", "representative" null, "shipping address" false, "state" null, "vat" null, "verified vat" false }, "country" "us", "email" "john\@example com", "id" "72b51cc1 613a 4189 a395 d5161b8a16c2", "last name" "doe", "locale" "en", "name" "john", "shipping information" {}, "stripe customer id" "cus pg4nuo1ibwahvc" }, "discounts" \[ { "applies to" \[ "619b5981 c097 4eb8 890b 5166b30880fd" ], "coupon" null, "discount" 1200, "duration" null, "id" null, "shipping discount" 0, "stripe coupon" "mj8w8abx" } ], "end date" 1712274818, "instalments" { "plans" \[], "selected plan" null }, "locale" "en", "object" "transaction", "payment" "stripe", "payments" \[], "products" \[ { "billing cycle" "month", "cancelled" false, "classification" "recurring service", "currency" "eur", "delivered" false, "discounts" \[ { "coupon" null, "discount" 1200, "duration" null, "id" null, "shipping discount" 0, "stripe coupon" "mj8w8abx" } ], "end date" 1714866818, "has shipping" false, "id" "619b5981 c097 4eb8 890b 5166b30880fd", "interval" 1, "is moss product" false, "is preorder" false, "is variant" false, "name" "subscription with trial", "quantity" 1, "reservations" \[], "start date" 1712274818, "stripe price id" "price 1ooskbfufeibdglbuwpv0oxf", "taxes" { "inclusive" false, "shipping tax rates" \[], "tax rates" \[] }, "totals" { "amount cancelled" 0, "amount paid" 0, "amount refunded" 0, "discount" 1200, "exchange rate" null, "item total" 8800, "item total with tax" 8800, "moss tax total" 0, "moss taxable amount" 0, "price conversion" false, "shipping" 0, "shipping discount" 0, "shipping subtotal" 0, "shipping tax" 0, "shipping total" 0, "subtotal" 10000, "tax" 0, "total" 8800, "unit price" 10000 }, "type" "billing plan", "variation id" null } ], "recurring" false, "shipping" { "has shipping" false, "item count" 0, "packages" \[], "shipping rates" \[] }, "start date" 1709596418, "taxes" { "has vat" false, "shipping tax rates" \[], "tax rates" \[] }, "totals" { "discount" 1200, "item count" 1, "item total" 8800, "item total with tax" 8800, "moss tax total" 0, "moss taxable amount" 0, "price conversion" false, "shipping" 0, "shipping discount" 0, "shipping subtotal" 0, "shipping tax" 0, "shipping total" 0, "subtotal" 10000, "tax" 0, "total" 8800, "trial deductions" 0 } } }