Skip to main content
GET
/
subscriptions
/
{id}
Get a subscription
curl --request GET \
  --url https://api.shoppex.io/dev/v1/subscriptions/{id} \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "id": "<string>",
    "shop_id": "<string>",
    "product_id": "<string>",
    "status": "PENDING",
    "gateway": "<string>",
    "origin": "<string>",
    "customer_id": "<string>",
    "payment_link_id": "<string>",
    "stripe_subscription_id": "<string>",
    "paypal_subscription_id": "<string>",
    "coupon_id": "<string>",
    "current_period_end": 123,
    "renewal_invoice_created": true,
    "trial_period_ending_email_sent": true,
    "upcoming_email_1_week_sent": true,
    "status_details": "<string>",
    "cancel_reason_id": 123,
    "cancel_reason_comment": "<string>",
    "created_at": 123,
    "updated_at": 123,
    "canceled_at": 123,
    "invoices": [
      {
        "id": "<string>",
        "uniqid": "<string>",
        "total": 123,
        "total_display": 123,
        "exchange_rate": 123,
        "crypto_exchange_rate": 123,
        "currency": "<string>",
        "shop_id": "<string>",
        "product_id": "<string>",
        "gateway": "<string>",
        "quantity": 123,
        "coupon_id": "<string>",
        "status": "<string>",
        "status_details": "<string>",
        "discount": 123,
        "created_at": 123,
        "updated_at": 123
      }
    ],
    "custom_fields": null
  }
}

Authorizations

Authorization
string
header
required

Use your API key with the Bearer scheme. Get your key from Dashboard → Settings → API Keys. Format: Authorization: Bearer shx_...

Path Parameters

id
string
required

Subscription ID

Response

Default Response

data
object
required