Retrieve an active entitlement

Changed on

Retrieve an active entitlement

get/v1/entitlements/active_entitlements/{id}

Request

  • Base URL: https://api.stripe.com
  • URL: https://api.stripe.com/v1/entitlements/active_entitlements/{id}
  • Auth: one of:
    • HTTP basic
    • HTTP bearer

Path parameters

idstring required

The ID of the entitlement.

Query parameters

expandstring[]

Specifies which fields in the response should be expanded.

Response

Successful response.

idstring required

Unique identifier for the object.

livemodeboolean required

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

lookup_keystring required

A unique key you provide as your own system identifier. This may be up to 80 characters.

object'entitlements.active_entitlement' required

String representing the object's type. Objects of the same type share the same value.

Changes

  • e24a26de4188Revision changes
    • breaking

      removed the required property //////////// from the response with the status

    • breaking

      removed the required property ////////// from the response with the status

    • breaking

      removed the required property ////////// from the response with the status

    This list may be incomplete.

Some revisions have not been checked yet.