Get Portal Subscription
GET
/portal/subscriptions/{id}Authorization
bearerAuth AuthorizationBearer <token>
In: header
Path Parameters
id*string
Response Body
application/json
application/json
curl -X GET "https://example.com/portal/subscriptions/string"{ "timezone": "string", "id": "string", "brand_id": "string", "status": "active", "plan": { "price_id": "string", "name": "string" }, "price": { "amount": 0, "currency": "string", "interval": "month" }, "next_charge_at": "string", "billing_day": 0, "period_ends_at": "string", "cancel_at": "string", "cancel_timing": "period_end", "pause_starts_at": "string", "paused_until": "string", "overdue": { "code": "payment_overdue", "failed_at": "string", "grace_ends_at": "string", "next_retry_at": "string", "tried": [ "string" ] }, "ended": { "ended_at": "string", "restart_terms": { "price": { "id": "string", "amount": 1, "currency": "usd", "interval": "month" }, "price_kept": true, "attempt": { "id": "string", "status": "open" }, "consent": { "seller_name": "string", "disclosure_version": "string", "disclosure_text": "string", "charge_terms_text": "string", "renewal": { "cadence": "string", "dueLine": "string", "renewLine": "string", "cancelLine": "string", "authorization": "string" } }, "action_hash": "string" }, "restart_unavailable_reason": "string", "deal_sold_out": true }, "payment_method_id": "string", "backup_payment_method_id": "string", "receipts": [ { "timezone": "string", "id": "string", "number": "string", "date": "string", "description": "string", "amount": { "amount": 0, "currency": "string" }, "amount_refunded": { "amount": 0, "currency": "string" }, "refund_status": "none", "refund_amount_known": true, "url": "string", "mixed": true, "item_ids": [ "string" ], "brand_ids": [ "string" ] } ], "plan_options": [], "scheduled_change": { "product_id": "string", "plan_id": "string", "price_id": "string", "name": "string", "quantity": 1, "interval": "string", "interval_count": 1, "amount": { "amount": -9007199254740991, "currency": "string" }, "effective_at": "2019-08-24T14:15:22Z", "kind": "plan" }, "cancel_reasons": [ { "id": "expensive", "label": "string" } ], "cancel_offers": [ { "action": "skip_period", "reasons": [ "expensive" ], "title": "string", "description": "string", "price_id": null, "max_months": 1 } ], "pause_max_periods": 1, "free_period": { "starts_at": "2019-08-24T14:15:22Z", "ends_at": "2019-08-24T14:15:22Z" }, "free_period_grant": { "operation_id": "cb4ede3c-a5d1-45e3-a9d2-fe83accbce52", "status": "pending", "failure": "discount_present" }, "allowed_flows": [ "update_payment_method" ], "latest_setup_attempt": 0}