Skip to main content
GET
/
dev
/
v1
/
subscriptions
/
{id}
Get subscription
curl --request GET \
  --url https://api.shoppex.io/dev/v1/subscriptions/{id} \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "id": "sub_1",
    "shop_id": "shop_1",
    "product_id": "prod_membership",
    "product": {
      "id": "prod_membership",
      "uniqid": "prod_public_membership",
      "title": "Pro Membership",
      "type": "SUBSCRIPTION",
      "subtype": "MONTHLY",
      "price": 19.99,
      "price_display": 19.99,
      "currency": "USD"
    },
    "uniqid": "sub_public_1",
    "status": "ACTIVE",
    "gateway": "STRIPE",
    "origin": null,
    "custom_fields": {
      "plan": "pro"
    },
    "customer_id": "cus_1",
    "payment_link_id": null,
    "stripe_subscription_id": "sub_stripe_1",
    "paypal_subscription_id": null,
    "coupon_id": null,
    "current_period_start": 1711510800,
    "current_period_end": 1714102800,
    "trial_end": null,
    "renewal_invoice_created": false,
    "trial_period_ending_email_sent": false,
    "upcoming_email_1_week_sent": false,
    "status_details": null,
    "cancel_reason_id": null,
    "cancel_reason_comment": null,
    "created_at": 1711510800,
    "updated_at": 1711510860,
    "canceled_at": null,
    "invoices": [
      {
        "id": "inv_sub_1",
        "uniqid": "44444444-4444-4444-8444-444444444444",
        "shop_id": "shop_1",
        "product_id": "prod_membership",
        "gateway": "STRIPE",
        "quantity": 1,
        "items": [
          {
            "product_id": "prod_membership",
            "product_title": "Pro Membership",
            "product_type": "SUBSCRIPTION",
            "variant_title": null,
            "quantity": 1,
            "unit_price": 19.99,
            "total": 19.99
          }
        ],
        "coupon_id": null,
        "status": "PAID",
        "status_details": null,
        "currency": "USD",
        "total": 19.99,
        "total_display": 19.99,
        "exchange_rate": 1,
        "crypto_exchange_rate": 0,
        "discount": 0,
        "created_at": 1711510800,
        "updated_at": 1711510860
      }
    ]
  }
}

Authorizations

Authorization
string
header
required

Use your Shoppex API key in the Authorization header.

Path Parameters

id
string
required

Response

200 - application/json

Successful response

data
object