PApaypal
Subscriptions

Retrieve lifetime usage for a specific subscription

get/subscriptions/{external_subscription_id}/lifetime-usage

Request

Path parameters

external_subscription_idstring required

The unique external identifier of the subscription

Response

Returns the lifetime usage for the specified subscription.

external_subscription_idstring

Unique external identifier of the subscription.

fromstring date-time

The start date and time (with timezone) of the tracked lifetime usage for the subscription.

tostring date-time

The end date and time (with timezone) of the tracked lifetime usage for the subscription.

Example response

{
  "external_subscription_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
  "external_historical_usage_amount": {
    "value": 120.35,
    "currency_code": "USD"
  },
  "invoiced_usage_amount": {
    "value": 120.35,
    "currency_code": "USD"
  },
  "current_usage_amount": {
    "value": 120.35,
    "currency_code": "USD"
  },
  "from": "2023-10-01T12:00:00Z",
  "to": "2023-10-01T12:00:00Z",
  "usage_thresholds": [
    {
      "amount": {
        "value": 120.35,
        "currency_code": "USD"
      },
      "completion_ratio": 0.5,
      "reached_at": "2024-01-01T00:00:00Z"
    }
  ]
}

Changes

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