v1

latestOpenAPI 3.1.02026-08-062951103.4 KB

subscriptions

Retrieve a subscription

get/subscriptions/{id}

Path parameters

idstring required

Subscription ID to retrieve

Response

idstring required

platform_idstring required

subscriber_idstring required

mrrstring required

status'active' | 'canceled' | 'future' | 'paused' | 'trialing' required

dataobject required

Additional data about the subscription from the connected subscription platform

created_atstring date-time required

updated_atstring date-time required

Example response

{
  "id": "subn_dp79dRR5wIy1kGW4PCO41wit",
  "platform_id": "sub_JE1trB8eUAnh0r",
  "subscriber_id": "subr_GQmXBebvivMb5tHhassNV9kj",
  "mrr": "399.95",
  "status": "active",
  "properties": [
    {
      "property": {
        "id": "prop_S6A17y8S8wgKBBJbveQHpLW6",
        "key": "is_professional",
        "name": "Is professional",
        "type": "boolean",
        "format": "null"
      },
      "formatted_value": "True"
    }
  ]
}