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.

Request body application/x-www-form-urlencoded

object required

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

  • b22313c11340Revision changes
    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    This list may be incomplete.

  • c113b1939b8fRevision changes
    • info

      added the optional property ////// to the response with the status

Some revisions have not been checked yet.