/subscriptions/{id}

GET

/subscriptions/{id}

curl --request GET \
  --url https://example.com/subscriptions/example

Retrieves the merchant-owned current state for a Proxy subscription.

Parameters

Path Parameters

id

required

string

/^psub_/

Responses

200

Default Response

Media typeapplication/json

object

buyer_reference

required

string

cancel_at

required

null | string

cancel_at_period_end

required

boolean

configuration_reason

required

null | string

configuration_status

required

string

Allowed values: action_required supported unknown

created_at

required

string

current_period_end

required

null | string

current_period_start

required

null | string

ended_at

required

null | string

id

required

string

/^psub_/

items_source_hash

required

null | string

items_updated_at

required

null | string

latest_invoice_amount_minor

required

null | integer

latest_invoice_currency

required

null | string

latest_invoice_id

required

null | string

latest_payment_status

required

null | string

original_proxy_session_id

required

string

/^psess_/

pause_collection_behavior

required

null | string

provider_checkout_session_id

required

null | string

provider_subscription_id

required

string

psp

required

string

status

required

string

trial_end

required

null | string

updated_at

required

string

diagnostic

required

object

provider_customer_id

required

null | string

items

required

Array<object>

<= 500 items

object

interval

required

string

Allowed values: day month week year

interval_count

required

integer

>= 1

provider_product_id

required

null | string

quantity

required

integer

>= 1

usage_type

required

string

Allowed values: licensed metered

provider_price_id

required

string

<= 255 characters /^(?:price_|plan_)/

Example

{
  "configuration_status": "action_required",
  "items": [
    {
      "interval": "day",
      "usage_type": "licensed"
    }
  ]
}

401

Default Response

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

request_id

required

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "request_id": "example"
  }
}

404

Default Response

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

request_id

required

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "request_id": "example"
  }
}

500

Default Response

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

request_id

required

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "request_id": "example"
  }
}