Sign in

v1

latestOpenAPI 3.1.02026-08-062951103.4 KB
subscriptions

Update a subscription

Update a subscription. Only the custom properties of a subscription can be modified.

Returns the updated subscription on success.

patch/subscriptions/{id}

Path parameters

idstring required

Subscription ID to update

Request body

propertiesobject

Object containing properties to update. Use property keys as the object keys.

You can use an empty string or null value to delete a property.

Read more about formatting custom properties.

Example request

{
  "properties": {
    "number_of_contacts": 5800,
    "is_professional": true
  }
}

Response

OK

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"
    }
  ]
}