Sign in
Cloud Internal

Returns the lists of correlated subscriptions for a customer

Returns the lists of correlated subscriptions for a customer.

get/api/internal/customers/{customerIdOrKey}/subscriptions-correlated

Path parameters

string required

ULID (Universally Unique Lexicographically Sortable Identifier).

OR
string required

ExternalKey is a looser version of key.

Example:01G65Z755AFWAKHE12NY0CQ9FH

Query parameters

activeAfterstring date-time
Example:2023-01-01T01:01:01.001Z

Active after date-time in RFC 3339 format. Inclusive. Filters for subscriptions that are active at or after the given date-time. Defaults to current time.

Response

The request has succeeded.

Example response

{
  "correlated": [
    [
      {
        "activeFrom": "2023-01-01T01:01:01.001Z",
        "activeTo": "2023-01-01T01:01:01.001Z",
        "annotations": {
          "externalId": "019142cc-a016-796a-8113-1a942fecd26d"
        },
        "billingAnchor": "2023-01-01T01:01:01.001Z",
        "billingCadence": "P1M",
        "costBasisPins": [
          {
            "costBasisId": "01G65Z755AFWAKHE12NY0CQ9FH",
            "customCurrencyId": "01G65Z755AFWAKHE12NY0CQ9FH",
            "invoiceCurrency": "USD"
          }
        ],
        "createdAt": "2024-01-01T01:01:01.001Z",
        "currency": "USD",
        "customerId": "01G65Z755AFWAKHE12NY0CQ9FH",
        "deletedAt": "2024-01-01T01:01:01.001Z",
        "id": "01G65Z755AFWAKHE12NY0CQ9FH",
        "metadata": {
          "externalId": "019142cc-a016-796a-8113-1a942fecd26d"
        },
        "plan": {
          "id": "01G65Z755AFWAKHE12NY0CQ9FH"
        },
        "updatedAt": "2024-01-01T01:01:01.001Z"
      }
    ]
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.