EasyflowEasyflowDocs

Get subscription

GET/subscriptions/{subscriptionId}

Returns the details of a subscription, including its recurrences and their payments.

Since 2026-10-30, the business-id header is required. Requests without it return 401 with the message BusinessId is required.

  • The API key must have read access to subscriptions, and its user must be a collaborator of the business sent in business-id.
  • A subscriptionId that is not a valid ID returns 400 with Invalid param: [id].
  • Up to 120 requests per minute for each user (all API keys of the same user share the limit). Above that, the API returns 429 with the Retry-After header.

Headers

  • x-api-keystringrequired

    Api key provided on integrations tab in Easyflow platform.

  • x-api-secretstringrequired

    Api Secret provided on integrations tab in Easyflow platform.

  • business-idstringrequired

    Business Identifier

Path parameters

  • subscriptionIdstringrequired

Responses

200Returns the details of the subscription.

Returns the details of the subscription.

Content typeapplication/jsonobject

  • statusCodeinteger

    Example:200

  • dataobject
    Show child attributesHide child attributes
    • idstring
    • namestring
    • originstring

      How the subscription was created: offer (from an offer), payment-link (from a payment link) or api (directly through the API).

      Possible values:offerpayment-linkapi

    • subscribedAtstring
    • periodicitystring

      Possible values:MonthlyQuarterlyBiannualyAnnualy

    • numberRecurrencesinteger
    • statusstring

      Status of the subscription.

      Possible values:activeinactivecanceledexpired

    • subscriptionPaymentStatusstring

      Payment status of the subscription.

      Possible values:pendingfaileddelayedpaidcanceled

    • customerobject
      Show child attributesHide child attributes
      • namestring
      • emailstring
      • phoneobject
        Show child attributesHide child attributes
        • areaCodestring
        • dddstring
        • numberstring
        • isMobileboolean
      • billingAddressobject
        Show child attributesHide child attributes
        • zipCodestringnullable
        • streetstringnullable
        • numberstringnullable
        • complementstringnullable
        • neighborhoodstringnullable
        • citystringnullable
        • statestringnullable
      • deliveryAddressobject
        Show child attributesHide child attributes
        • zipCodestringnullable
        • streetstringnullable
        • numberstringnullable
        • complementstringnullable
        • neighborhoodstringnullable
        • citystringnullable
        • statestringnullable
      • documentobject
        Show child attributesHide child attributes
        • typestring
        • numberstring
      • userIdstring
      • externalReferenceIdstring
    • orderItemobject
      Show child attributesHide child attributes
      • idstring
      • productobjectnullable

        Product of the subscription. It is null when the subscription has no product.

        Show child attributesHide child attributes
        • idstring
        • namestring
        • businessIdstring
      • unitValueInCentsinteger
      • quantityinteger
    • recurrenceValueInCentsinteger
    • expirationstringnullable
    • paymentMethodstring

      Possible values:credit-cardpixbank-billetcryptodebit-cardtransfer

    • creditCardobject
      Show child attributesHide child attributes
      • nicknamestringnullable
      • last4Numbersstring
      • holderNamestring
      • expiresAtMonthinteger
      • expiresAtYearinteger
      • flagstring

        Possible values:visamastercardamerican-expressdiners-clubdiscoverjcbunionpaymaestromirelohiperhipercard

    • repeatIndefinitelyboolean
    • customValueobject
      Show child attributesHide child attributes
      • recurrenceFrominteger
      • recurrenceTointeger
      • valueInCentsinteger
    • recurrencesarray of objects
      Show child attributesHide child attributes
      • recurrenceinteger
      • billingDatestring
      • dueDatestring
      • paidAtstring
      • recurrenceValueInCentsinteger
      • statusstring

        Possible values:pendingchargeddelayedfailedpaidcanceledrefunded

      • paymentsarray of objects
        Show child attributesHide child attributes
        • idstring
        • statusstring

          Possible values:pendingin-processingauthorizedpaidpartially-paidrefusedabortedcanceledcharged-backchargeback-in-disputeunpaidaccepteddeniedreversedrefunded

        • valuePaidInCentsinteger
        • externalIdstringnullable
        • fineValueInCentsinteger
        • installmentsinteger
        • interestValueInCentsinteger
        • paymentMethodstring

          Possible values:credit-cardpixbank-billetcryptodebit-cardtransfer

        • valueInCentsinteger
400The subscription does not exist (message Invalid param: [subscriptionId]), or subscriptionId is not a valid ID (message Invalid param: [id]).

The subscription does not exist (message Invalid param: [subscriptionId]), or subscriptionId is not a valid ID (message Invalid param: [id]).

Content typeapplication/jsonobject

  • messagestring

    Invalid param: []

    Example:Invalid param: []

  • errorstring

    Bad Request

    Example:Bad Request

  • statusCodeinteger

    400

    Example:400

  • errorCodestring

    Code that identifies the error. Present only on some errors.

401The credential is missing or invalid, or the business-id header is missing (message BusinessId is required).

The credential is missing or invalid, or the business-id header is missing (message BusinessId is required).

Content typeapplication/jsonobject

  • messagestring

    Invalid field

    Example:Unauthorized

  • errorstring

    Unauthorized

    Example:Unauthorized

  • statusCodeinteger

    401

    Example:401

403The API key has no read access to subscriptions, or its user is not a collaborator of the business sent in business-id.

The API key has no read access to subscriptions, or its user is not a collaborator of the business sent in business-id.

Content typeapplication/jsonobject

  • messagestring

    Forbidden resource

    Example:Forbidden resource

  • errorstring

    Forbidden

    Example:Forbidden

  • statusCodeinteger

    403

    Example:403

429More than 120 requests in a minute for the user (all API keys of the same user share the limit). The message is Too many requests, retry after the Retry-After seconds. Wait the number of seconds in the Retry-After header before sending a new request.

More than 120 requests in a minute for the user (all API keys of the same user share the limit). The message is Too many requests, retry after the Retry-After seconds. Wait the number of seconds in the Retry-After header before sending a new request.

Content typeapplication/jsonobject

  • statusCodeinteger

    HTTP status code.

    Example:429

  • messagestring

    Explanation of the error.

    Example:Too many requests, retry after the Retry-After seconds

500If an unexpected condition occurs and the server cannot process the request, the API will return the following error response. This response has no error field.

If an unexpected condition occurs and the server cannot process the request, the API will return the following error response. This response has no error field.

Content typeapplication/jsonobject

  • statusCodeinteger

    HTTP status code.

    Example:500

  • messagestring

    Explanation of the error.

    Example:Internal Server Error