# Get subscription status

By using this method, merchants can retrieve subscription data by subscription identifier and obtain its details, such as the start date, status, and the information about the most recent invoice related to the subscription.

Endpoint: POST /subscription/status
Version: 1.0.0
Security: MerchantID

## Header parameters:

  - `merchant` (string, required)
    Unique public key provided upon registration and must be shared for identification purposes.
    Example: "api_pk_7b197...ba108f842"

  - `signature` (string, required)
    Request signature that allows verification of merchant authenticity on the payment gateway server.
    Example: "M2E3OTkyNzcz...xMmExODI4"

## Request fields (application/json):

  - `subscription_id` (string, required)
    Unique subscription identifier.
    Example: "83b19018-cbc4-45f0-899a-dda84fd2705e"

## Response 200 fields (application/json):

  - `body` (object) — one of:
    - Success:
      - `subscription` (object, required) — one of (discriminator: status):
        Subscription details, including its status, payment method, and other essential information for tracking and managing its lifecycle.
        Example: {"id":"9e252e9f-c5a3-4dca-93df-4c9fcf54267e","status":"active","started_at":"2025-12-08 12:37:24","updated_at":"2025-12-08 12:37:25","expired_at":"2025-12-12 12:37:24","next_charge_at":"2025-12-12 14:37:24","payment_type":"card","trial":false,"discount":{"created_at":"2025-05-31 12:53:12","coupon_code":"SUMMER25OFF","coupon":{"name":"Summer 25% OFF","description":"25% off for 3 months","type":"percentage","value":25}},"trial_started_at":"2025-12-08 12:37:24","trial_ended_at":"2025-12-08 12:37:25","cancelled_at":"2025-12-12 19:37:24","cancellation_requested_at":"2025-12-11 19:37:24","cancel_code":"8.09","cancel_message":"Cancellation after redemption period","pause":{"from_date":"2025-03-27 11:26:08","to_date":"2025-03-27 11:26:08"}}
        - pending:
          - `id` (string, required)
            Unique subscription identifier.
            Example: "9e252e9f-c5a3-4dca-93df-4c9fcf54267e"
          - `started_at` (string)
            Datetime of the subscription start.
            Example: "2025-12-08 12:37:24"
          - `updated_at` (string, required)
            Datetime of the subscription update.
            Example: "2025-12-08 12:37:25"
          - `expired_at` (string)
            Datetime of the subscription expiration.
            Example: "2025-12-12 12:37:24"
          - `payment_type` (string)
            Customer payment method used to pay for a subscription.
            Enum: "card", "paypal-vault", "mercadopago", "upi", "pix", "gcash", "alipay", "mbway", "wechatpay"
          - `discount` (object)
            Contains information about the discount applied.
          - `discount.created_at` (string, required)
            Datetime of the discount creation.
            Example: "2025-05-31 12:53:12"
          - `discount.coupon_code` (string)
            Coupon code.
            Example: "SUMMER25OFF"
          - `discount.coupon` (object, required)
            Coupon details.
          - `discount.coupon.name` (string, required)
            Coupon name.
            Example: "Summer 25% OFF"
          - `discount.coupon.description` (string)
            Coupon description.
            Example: "25% off for 3 months"
          - `discount.coupon.type` (string, required)
            Discount type indicating percentage or fixed amount off the price.
            Enum: "percentage", "amount"
          - `discount.coupon.value` (integer, required)
            Discount value.


  Depending on the coupon type, the value represents either a percentage or a fixed amount.
            Example: 25
          - `trial` (boolean, required)
            Indicates whether the subscription has a trial.
          - `trial_started_at` (string)
            Datetime of the subscription trial start.
            Example: "2025-12-08 12:37:24"
          - `trial_ended_at` (string)
            Datetime of the subscription trial expiration.
            Example: "2025-12-08 12:37:25"
          - `cancelled_at` (string)
            Datetime of subscription cancellation.
            Example: "2025-12-12 19:37:24"
          - `cancellation_requested_at` (string)
            Datetime of subscription cancellation request.
            Example: "2025-12-11 19:37:24"
          - `cancel_code` (string)
            Reason code that is used to cancel the subscription.
            Enum: "8.01", "8.02", "8.03", "8.04", "8.05", "8.06", "8.07", "8.08", "8.09", "8.10", "8.11", "8.12", "8.13", "8.14", "8.15"
          - `cancel_message` (string)
            Cancellation reason brief description.
            Example: "Cancellation after redemption period"
          - `pause` (object)
            Pause schedule parameters.
          - `pause.from_date` (string, required)
            Datetime of the pause start.


   If the subscription pause type value is immediate, the datetime is the date and time of the pause start request.
            Example: "2025-12-27 11:26:08"
          - `pause.to_date` (string)
            Datetime of the pause end.


  It is absent when the subscription is planned to pause infinitely.
            Example: "2025-12-27 11:26:08"
        - active:
          - `id` (string, required)
            Unique subscription identifier.
            Example: "9e252e9f-c5a3-4dca-93df-4c9fcf54267e"
          - `started_at` (string, required)
            Datetime of the subscription start.
            Example: "2025-12-08 12:37:24"
          - `updated_at` (string, required)
            Datetime of the subscription update.
            Example: "2025-12-08 12:37:25"
          - `expired_at` (string)
            Datetime of the subscription expiration.
            Example: "2025-12-12 12:37:24"
          - `next_charge_at` (string)
            Datetime of the subsequent charge.


  It is absent when the subscription is planned to pause infinitely.
            Example: "2025-12-12 14:37:24"
          - `payment_type` (string, required)
            Customer payment method used to pay for a subscription.
            Enum: same as `payment_type` in "pending" (9 values)
          - `discount` (object)
            Contains information about the discount applied.
          - `discount.created_at` (string, required)
            Datetime of the discount creation.
            Example: "2025-05-31 12:53:12"
          - `discount.coupon_code` (string)
            Coupon code.
            Example: "SUMMER25OFF"
          - `discount.coupon` (object, required)
            Coupon details.
          - `discount.coupon.name` (string, required)
            Coupon name.
            Example: "Summer 25% OFF"
          - `discount.coupon.description` (string)
            Coupon description.
            Example: "25% off for 3 months"
          - `discount.coupon.type` (string, required)
            Discount type indicating percentage or fixed amount off the price.
            Enum: same as `discount.coupon.type` in "pending" (2 values)
          - `discount.coupon.value` (integer, required)
            Discount value.


  Depending on the coupon type, the value represents either a percentage or a fixed amount.
            Example: 25
          - `trial` (boolean, required)
            Indicates whether the subscription has a trial.
          - `trial_started_at` (string)
            Datetime of the subscription trial start.
            Example: "2025-12-08 12:37:24"
          - `trial_ended_at` (string)
            Datetime of the subscription trial expiration.
            Example: "2025-12-08 12:37:25"
          - `cancelled_at` (string)
            Datetime of subscription cancellation.
            Example: "2025-12-12 19:37:24"
          - `cancellation_requested_at` (string)
            Datetime of subscription cancellation request.
            Example: "2025-12-11 19:37:24"
          - `cancel_code` (string)
            Reason code that is used to cancel the subscription.
            Enum: same as `cancel_code` in "pending" (15 values)
          - `cancel_message` (string)
            Cancellation reason brief description.
            Example: "Cancellation after redemption period"
          - `pause` (object)
            Pause schedule parameters.
          - `pause.from_date` (string, required)
            Datetime of the pause start.


   If the subscription pause type value is immediate, the datetime is the date and time of the pause start request.
            Example: "2025-03-27 11:26:08"
          - `pause.to_date` (string)
            Datetime of the pause end.


  It is absent when the subscription is planned to pause infinitely.
            Example: "2025-03-27 11:26:08"
        - cancelled:
          - `id` (string, required)
            Unique subscription identifier.
            Example: "9e252e9f-c5a3-4dca-93df-4c9fcf54267e"
          - `started_at` (string, required)
            Datetime of the subscription start.
            Example: "2025-12-08 12:37:24"
          - `updated_at` (string, required)
            Datetime of the subscription update.
            Example: "2025-12-08 12:37:25"
          - `expired_at` (string)
            Datetime of the subscription expiration.
            Example: "2025-12-12 12:37:24"
          - `payment_type` (string, required)
            Customer payment method used to pay for a subscription.
            Enum: same as `payment_type` in "pending" (9 values)
          - `discount` (object)
            Contains information about the discount applied.
          - `discount.created_at` (string, required)
            Datetime of the discount creation.
            Example: "2025-05-31 12:53:12"
          - `discount.coupon_code` (string)
            Coupon code.
            Example: "SUMMER25OFF"
          - `discount.coupon` (object, required)
            Coupon details.
          - `discount.coupon.name` (string, required)
            Coupon name.
            Example: "Summer 25% OFF"
          - `discount.coupon.description` (string)
            Coupon description.
            Example: "25% off for 3 months"
          - `discount.coupon.type` (string, required)
            Discount type indicating percentage or fixed amount off the price.
            Enum: same as `discount.coupon.type` in "pending" (2 values)
          - `discount.coupon.value` (integer, required)
            Discount value.


  Depending on the coupon type, the value represents either a percentage or a fixed amount.
            Example: 25
          - `trial` (boolean, required)
            Indicates whether the subscription has a trial.
          - `trial_started_at` (string)
            Datetime of the subscription trial start.
            Example: "2025-12-08 12:37:24"
          - `trial_ended_at` (string)
            Datetime of the subscription trial expiration.
            Example: "2025-12-08 12:37:25"
          - `cancelled_at` (string)
            Datetime of subscription cancellation.
            Example: "2025-12-12 19:37:24"
          - `cancellation_requested_at` (string)
            Datetime of subscription cancellation request.
            Example: "2025-12-11 19:37:24"
          - `cancel_code` (string)
            Reason code that is used to cancel the subscription.
            Enum: same as `cancel_code` in "pending" (15 values)
          - `cancel_message` (string)
            Cancellation reason brief description.
            Example: "Cancellation after redemption period"
          - `pause` (object)
            Pause schedule parameters.
          - `pause.from_date` (string, required)
            Datetime of the pause start.


   If the subscription pause type value is immediate, the datetime is the date and time of the pause start request.
            Example: "2025-03-27 11:26:08"
          - `pause.to_date` (string)
            Datetime of the pause end.


  It is absent when the subscription is planned to pause infinitely.
            Example: "2025-03-27 11:26:08"
        - redemption:
          - `id` (string, required)
            Unique subscription identifier.
            Example: "9e252e9f-c5a3-4dca-93df-4c9fcf54267e"
          - `started_at` (string, required)
            Datetime of the subscription start.
            Example: "2025-12-08 12:37:24"
          - `updated_at` (string, required)
            Datetime of the subscription update.
            Example: "2025-12-08 12:37:25"
          - `expired_at` (string)
            Datetime of the subscription expiration.
            Example: "2025-12-12 12:37:24"
          - `next_charge_at` (string)
            Datetime of the subsequent charge.


  It is absent when the subscription is planned to pause infinitely.
            Example: "2025-12-12 14:37:24"
          - `payment_type` (string, required)
            Customer payment method used to pay for a subscription.
            Enum: same as `payment_type` in "pending" (9 values)
          - `discount` (object)
            Contains information about the discount applied.
          - `discount.created_at` (string, required)
            Datetime of the discount creation.
            Example: "2025-05-31 12:53:12"
          - `discount.coupon_code` (string)
            Coupon code.
            Example: "SUMMER25OFF"
          - `discount.coupon` (object, required)
            Coupon details.
          - `discount.coupon.name` (string, required)
            Coupon name.
            Example: "Summer 25% OFF"
          - `discount.coupon.description` (string)
            Coupon description.
            Example: "25% off for 3 months"
          - `discount.coupon.type` (string, required)
            Discount type indicating percentage or fixed amount off the price.
            Enum: same as `discount.coupon.type` in "pending" (2 values)
          - `discount.coupon.value` (integer, required)
            Discount value.


  Depending on the coupon type, the value represents either a percentage or a fixed amount.
            Example: 25
          - `trial` (boolean, required)
            Indicates whether the subscription has a trial.
          - `trial_started_at` (string)
            Datetime of the subscription trial start.
            Example: "2025-12-08 12:37:24"
          - `trial_ended_at` (string)
            Datetime of the subscription trial expiration.
            Example: "2025-12-08 12:37:25"
          - `cancel_code` (string)
            Reason code that is used to cancel the subscription.
            Enum: same as `cancel_code` in "pending" (15 values)
          - `cancel_message` (string)
            Cancellation reason brief description.
            Example: "Cancellation after redemption period"
          - `pause` (object)
            Pause schedule parameters.
          - `pause.from_date` (string, required)
            Datetime of the pause start.


   If the subscription pause type value is immediate, the datetime is the date and time of the pause start request.
            Example: "2025-03-27 11:26:08"
          - `pause.to_date` (string)
            Datetime of the pause end.


  It is absent when the subscription is planned to pause infinitely.
            Example: "2025-03-27 11:26:08"
        - paused:
          - `id` (string, required)
            Unique subscription identifier.
            Example: "9e252e9f-c5a3-4dca-93df-4c9fcf54267e"
          - `started_at` (string, required)
            Datetime of the subscription start.
            Example: "2025-12-08 12:37:24"
          - `updated_at` (string, required)
            Datetime of the subscription update.
            Example: "2025-12-08 12:37:25"
          - `expired_at` (string)
            Datetime of the subscription expiration.
            Example: "2025-12-12 12:37:24"
          - `next_charge_at` (string)
            Datetime of the subsequent charge.


  It is absent when the subscription is planned to pause infinitely.
            Example: "2025-12-12 14:37:24"
          - `payment_type` (string, required)
            Customer payment method used to pay for a subscription.
            Enum: same as `payment_type` in "pending" (9 values)
          - `discount` (object)
            Contains information about the discount applied.
          - `discount.created_at` (string, required)
            Datetime of the discount creation.
            Example: "2025-05-31 12:53:12"
          - `discount.coupon_code` (string)
            Coupon code.
            Example: "SUMMER25OFF"
          - `discount.coupon` (object, required)
            Coupon details.
          - `discount.coupon.name` (string, required)
            Coupon name.
            Example: "Summer 25% OFF"
          - `discount.coupon.description` (string)
            Coupon description.
            Example: "25% off for 3 months"
          - `discount.coupon.type` (string, required)
            Discount type indicating percentage or fixed amount off the price.
            Enum: same as `discount.coupon.type` in "pending" (2 values)
          - `discount.coupon.value` (integer, required)
            Discount value.


  Depending on the coupon type, the value represents either a percentage or a fixed amount.
            Example: 25
          - `trial` (boolean, required)
            Indicates whether the subscription has a trial.
          - `trial_started_at` (string)
            Datetime of the subscription trial start.
            Example: "2025-12-08 12:37:24"
          - `trial_ended_at` (string)
            Datetime of the subscription trial expiration.
            Example: "2025-12-08 12:37:25"
          - `cancel_code` (string)
            Reason code that is used to cancel the subscription.
            Enum: same as `cancel_code` in "pending" (15 values)
          - `cancel_message` (string)
            Cancellation reason brief description.
            Example: "Cancellation after redemption period"
          - `pause` (object)
            Pause schedule parameters.
          - `pause.from_date` (string, required)
            Datetime of the pause start.


   If the subscription pause type value is immediate, the datetime is the date and time of the pause start request.
            Example: "2025-03-27 11:26:08"
          - `pause.to_date` (string)
            Datetime of the pause end.


  It is absent when the subscription is planned to pause infinitely.
            Example: "2025-03-27 11:26:08"
        - expired:
          - `id` (string, required)
            Unique subscription identifier.
            Example: "9e252e9f-c5a3-4dca-93df-4c9fcf54267e"
          - `started_at` (string)
            Datetime of the subscription start.
            Example: "2025-12-08 12:37:24"
          - `updated_at` (string, required)
            Datetime of the subscription update.
            Example: "2025-12-08 12:37:25"
          - `expired_at` (string)
            Datetime of the subscription expiration.
            Example: "2025-12-12 12:37:24"
          - `payment_type` (string)
            Customer payment method used to pay for a subscription.
            Enum: same as `payment_type` in "pending" (9 values)
          - `discount` (object)
            Contains information about the discount applied.
          - `discount.created_at` (string, required)
            Datetime of the discount creation.
            Example: "2025-05-31 12:53:12"
          - `discount.coupon_code` (string)
            Coupon code.
            Example: "SUMMER25OFF"
          - `discount.coupon` (object, required)
            Coupon details.
          - `discount.coupon.name` (string, required)
            Coupon name.
            Example: "Summer 25% OFF"
          - `discount.coupon.description` (string)
            Coupon description.
            Example: "25% off for 3 months"
          - `discount.coupon.type` (string, required)
            Discount type indicating percentage or fixed amount off the price.
            Enum: same as `discount.coupon.type` in "pending" (2 values)
          - `discount.coupon.value` (integer, required)
            Discount value.


  Depending on the coupon type, the value represents either a percentage or a fixed amount.
            Example: 25
          - `trial` (boolean, required)
            Indicates whether the subscription has a trial.
          - `trial_started_at` (string)
            Datetime of the subscription trial start.
            Example: "2025-12-08 12:37:24"
          - `trial_ended_at` (string)
            Datetime of the subscription trial expiration.
            Example: "2025-12-08 12:37:25"
          - `cancelled_at` (string)
            Datetime of subscription cancellation.
            Example: "2025-12-12 19:37:24"
          - `cancellation_requested_at` (string)
            Datetime of subscription cancellation request.
            Example: "2025-12-11 19:37:24"
          - `cancel_code` (string)
            Reason code that is used to cancel the subscription.
            Enum: same as `cancel_code` in "pending" (15 values)
          - `cancel_message` (string)
            Cancellation reason brief description.
            Example: "Cancellation after redemption period"
          - `pause` (object)
            Pause schedule parameters.
          - `pause.from_date` (string, required)
            Datetime of the pause start.


   If the subscription pause type value is immediate, the datetime is the date and time of the pause start request.
            Example: "2025-12-27 11:26:08"
          - `pause.to_date` (string)
            Datetime of the pause end.


  It is absent when the subscription is planned to pause infinitely.
            Example: "2025-12-27 11:26:08"
      - `subscription.status` (string)
        Subscription status.
        Example: "active"
      - `product` (object, required)
        Subscription product details, including name, pricing logic, amount, currency, trial settings, and other related attributes.


  The list of fields within the object differs from the field set during the creation of the product request.
      - `product.id` (string, required)
        Unique product identifier.


  It corresponds to the product_id parameter.
        Example: "a51ba9fd-3be1-4ef9-b00f-bb85157597f5"
      - `product.name` (string, required)
        Product name.
        Example: "Platinum Audiobook Set"
      - `product.payment_action` (string)
        Specifies a payment flow applied to the first transaction.
        Example: "auth_void"
      - `product.price_id` (string, required)
        Unique product price identifier.
        Example: "61b7f690-242a-498c-99a1-eb191f93f08c"
      - `product.amount` (integer, required)
        Product price.
        Example: 100
      - `product.currency` (string, required)
        Three-letter ISO-4217 currency code of the product price currency.
        Example: "USD"
      - `product.trial` (boolean, required)
        Indicates whether the product has a trial.
        Example: true
      - `product.trial_period` (integer)
        Indicates the trial period in minutes.
        Example: 1
      - `product.trial_amount` (integer)
        Trial price.
        Example: 99
      - `product.trial_currency` (string)
        Three-letter ISO-4217 currency code of the trial price currency.
        Example: "USD"
      - `customer` (object, required)
        Customer details related to the subscription, including key information such as the customer's email address.
      - `customer.customer_account_id` (string, required)
        Unique customer identifier defined by the merchant.
        Example: "93a1c659-288d-4d62-929d-10e241078faa"
      - `customer.customer_email` (string, required)
        Customer's email address.
        Example: "example@example.com"
      - `invoices` (object, required)
        Latest invoice for the subscription, including billing information, current state, financial details, and associated order history.
      - `invoices.<invoice_id_value_#1>` (object, required)
        Single invoice, where `` is a dynamically generated unique invoice identifier.
      - `invoices.<invoice_id_value_#1>.id` (string, required)
        Unique invoice identifier associated with a specific subscription.
        Example: "4022a203-ace8-415f-9ae7-730014fceb25"
      - `invoices.<invoice_id_value_#1>.status` (string, required)
        Invoice status.
        Enum: "processing", "retry", "success", "fail"
      - `invoices.<invoice_id_value_#1>.created_at` (string, required)
        Datetime of the invoice creation.
        Example: "2025-12-27 11:45:30"
      - `invoices.<invoice_id_value_#1>.updated_at` (string, required)
        Datetime of the invoice update.
        Example: "2025-12-28 11:45:30"
      - `invoices.<invoice_id_value_#1>.amount` (integer, required)
        Current subscription price.
        Example: 100
      - `invoices.<invoice_id_value_#1>.product_price_id` (string)
        Unique product price identifier applied to the invoice. Use it to distinguish
prices configured for different currencies and locations within the
same product for product and price management.


  null is returned if the product has no prices configured for
  other currencies and locations.
        Example: "61b7f690-242a-498c-99a1-eb191f93f08c"
      - `invoices.<invoice_id_value_#1>.discount` (object)
        Contains information about the discount applied.
      - `invoices.<invoice_id_value_#1>.discount.created_at` (string, required)
        Datetime of the discount creation.
        Example: "2025-05-31 12:53:12"
      - `invoices.<invoice_id_value_#1>.discount.coupon_code` (string)
        Coupon code.
        Example: "SUMMER25OFF"
      - `invoices.<invoice_id_value_#1>.discount.coupon` (object, required)
        Coupon details.
      - `invoices.<invoice_id_value_#1>.discount.coupon.name` (string, required)
        Coupon name.
        Example: "Summer 2025"
      - `invoices.<invoice_id_value_#1>.discount.coupon.description` (string, required)
        Coupon description.
        Example: "25% off for 3 months"
      - `invoices.<invoice_id_value_#1>.discount.coupon.type` (string, required)
        Discount type indicating percentage or fixed amount off the price.
        Enum: same as `discount.coupon.type` in "pending" (2 values)
      - `invoices.<invoice_id_value_#1>.discount.coupon.value` (integer, required)
        Discount value.


  Depending on the coupon type, the value represents either a percentage or a fixed amount.
        Example: 25
      - `invoices.<invoice_id_value_#1>.billing_period_started_at` (string)
        Start datetime of the period covered by the invoice.


  Filled if invoice is in the success status.
        Example: "2025-12-29 11:45:30"
      - `invoices.<invoice_id_value_#1>.billing_period_ended_at` (string)
        End datetime of the period covered by the invoice.


  Filled if invoice is in the success status.
        Example: "2025-12-30 11:45:30"
      - `invoices.<invoice_id_value_#1>.subscription_term_number` (integer)
        Indicates the number of passed subscription periods, excluding the trial period. The value increments when a new billing period begins or when the subscription is upgraded or downgraded with a billing period change.


  Filled if invoice is created:
  
    before March 1, 2024 only for the invoice with a success status
    on or after March 1, 2024, regardless of the invoice status
        Example: 1
      - `invoices.<invoice_id_value_#1>.orders` (object)
        Map of orders, including details such as current status, creation and processing timestamps, and other related transaction information.
      - `invoices.<invoice_id_value_#1>.orders.<order_id_value_#1>` (object)
        Single order, where `` is a dynamically generated unique order identifier.
      - `invoices.<invoice_id_value_#1>.orders.<order_id_value_#1>.id` (string, required)
        Unique order identifier, which can be used to find the payment.


  For the first payment, the identifier is defined by the merchant.
  For recurring subscription-based payments, it is generated by the Solidgate subscription service.
        Example: "1672066481283AlexKho"
      - `invoices.<invoice_id_value_#1>.orders.<order_id_value_#1>.status` (string, required)
        Status of the requested order.


  Card order statuses are created, processing, 3ds_verify, auth_ok, auth_failed, void_ok, settle_ok, and refunded. Card order status partial_settled is not used in subscriptions.
  
  APM order statuses are created, processing, approved, declined, and refunded. APM order status settle_pending is not used in subscriptions.
        Enum: "created", "processing", "3ds_verify", "auth_ok", "auth_failed", "void_ok", "settle_ok", "refunded", "approved", "declined"
      - `invoices.<invoice_id_value_#1>.orders.<order_id_value_#1>.created_at` (string, required)
        Datetime of the order creation.
        Example: "2025-12-27 11:45:30"
      - `invoices.<invoice_id_value_#1>.orders.<order_id_value_#1>.processed_at` (string)
        Datetime when the order was processed.


  It is empty for orders in processing.
        Example: "2025-12-28 11:45:30"
      - `invoices.<invoice_id_value_#1>.orders.<order_id_value_#1>.amount` (integer, required)
        Original order amount.
        Example: 100
      - `invoices.<invoice_id_value_#1>.orders.<order_id_value_#1>.payment_details` (object)
        Details of the payer for transactions conducted through APMs.


  It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method.
      - `invoices.<invoice_id_value_#1>.orders.<order_id_value_#1>.payment_details.invoice_id` (string)
        Unique invoice identifier provided by PayPal.


  It is provided only for the transactions with paypal-vault method.
        Example: "4022a203-ace8-415f-9ae7-730014fceb25"
      - `invoices.<invoice_id_value_#1>.orders.<order_id_value_#1>.payment_details.payer_email` (string)
        Customer's email.


  It is provided only for the transactions with paypal-vault method.
        Example: "example@example.com"
      - `invoices.<invoice_id_value_#1>.orders.<order_id_value_#1>.retry_attempt` (integer)
        Indicates the number of retry attempt for the invoice.


  Filled for orders created according to retry strategy.
        Example: 1
      - `invoices.<invoice_id_value_#1>.orders.<order_id_value_#1>.operation` (string)
        Type of the transaction.
        Enum: "pay", "recurring", "recurring-auth", "refund", "resign", "resign-auth", "auth", "settle", "void", "apple-pay", "google-pay"
    - Error:
      - `error` (object)
        Error object.
      - `error.code` (string, required)
        Error code that identifies the validation failure.


  This code is returned when the input data does not meet the expected criteria.
        Enum: "2.01"
      - `error.messages` (object, required)
        Contains field-specific error messages.


  Each key is a field name. Each value is an array of strings that describe validation issues.
        Example: {"subscription":["Validation error"]}

## Response 400 fields (application/json):

  - `error` (object, required)
    Error object.

  - `error.code` (string, required)
    Error code.
    Example: "2.01"

  - `error.message` (string, required)
    Error message.
    Example: "Validation error"

  - `error.constraints` (object)
    Map of constraints.

## Response 401 fields (application/json):

  - `error` (object, required)
    Error object.

  - `error.code` (string, required)
    Error code indicating the specific authorization failure.
    Example: "1.01"

  - `error.message` (string, required)
    Descriptive message providing more details about the authorization failure.
    Example: "Authorization failed"

## Response 403 fields (application/json):

  - `error` (object, required)
    Error object.

  - `error.code` (string, required)
    Error code indicating that access to the service is denied.
    Example: "1.02"

  - `error.message` (string, required)
    Message informing that the service is not allowed for the account.
    Example: "Access denied"

## Response 404 fields (application/json):

  - `error` (object, required)
    Error object.

  - `error.code` (string, required)
    Error code.
    Example: "2.01"

  - `error.message` (string, required)
    Error message.
    Example: "{entityName} not found with id: {entityId}"