---
updatedAt: 2025-11-13T16:07:23.000Z
agentTools:
  projectIndex: https://developers.bluesnap.com/v8976-Extended/llms.txt
---

# subscription

### Request

<Table align={["left","left","left","left"]}>
  <thead>
    <tr>
      <th style={{ textAlign: "left" }}>
        Property Name
      </th>

      <th style={{ textAlign: "left" }}>
        Type
      </th>

      <th style={{ textAlign: "left" }}>
        Required
      </th>

      <th style={{ textAlign: "left" }}>
        Description
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td style={{ textAlign: "left" }}>
        `status`
      </td>

      <td style={{ textAlign: "left" }}>
        *string*
      </td>

      <td style={{ textAlign: "left" }}>
        Optional
      </td>

      <td style={{ textAlign: "left" }}>
        Status of the subscription:  

        * **A** = Active  
        * **C** = Cancelled  
        * **D** = Declined
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        `cancellation-reason`
      </td>

      <td style={{ textAlign: "left" }}>
        *string*
      </td>

      <td style={{ textAlign: "left" }}>
        Optional
      </td>

      <td style={{ textAlign: "left" }}>
        Reason for the subscription's cancellation. 50-character limit.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        `underlying-sku-id`
      </td>

      <td style={{ textAlign: "left" }}>
        *long*
      </td>

      <td style={{ textAlign: "left" }}>
        Optional\
        (required with `quantity`)
      </td>

      <td style={{ textAlign: "left" }}>
        ID of the SKU (contract) that the subscription is attributed to.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        `underlying-sku-name`
      </td>

      <td style={{ textAlign: "left" }}>
        *string*
      </td>

      <td style={{ textAlign: "left" }}>
        Optional
      </td>

      <td style={{ textAlign: "left" }}>
        Name of the SKU (contract) that the subscription is attributed to.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        `shopper-id`
      </td>

      <td style={{ textAlign: "left" }}>
        *long*
      </td>

      <td style={{ textAlign: "left" }}>
        Optional
      </td>

      <td style={{ textAlign: "left" }}>
        BlueSnap's global ID for the shopper who purchased the subscription.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        `credit-card`
      </td>

      <td style={{ textAlign: "left" }}>
        container
      </td>

      <td style={{ textAlign: "left" }}>
        Optional
      </td>

      <td style={{ textAlign: "left" }}>
        Container of [credit-card](https://developers.bluesnap.com/reference/credit-card) properties.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        `paypal`
      </td>

      <td style={{ textAlign: "left" }}>
        *string*
      </td>

      <td style={{ textAlign: "left" }}>
        Optional
      </td>

      <td style={{ textAlign: "left" }}>
        Empty field to indicate a PayPal charge, consists only of the tag.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        `paypal-subscription`
      </td>

      <td style={{ textAlign: "left" }}>
        container
      </td>

      <td style={{ textAlign: "left" }}>
        Optional
      </td>

      <td style={{ textAlign: "left" }}>
        Container of [paypal-subscription](https://developers.bluesnap.com/reference/paypal-subscription) properties.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        `override-recurring-charge`
      </td>

      <td style={{ textAlign: "left" }}>
        container
      </td>

      <td style={{ textAlign: "left" }}>
        Optional
      </td>

      <td style={{ textAlign: "left" }}>
        Container of [override-recurring-charge](https://developers.bluesnap.com/reference/override-recurring-charge) properties.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        `coupon`
      </td>

      <td style={{ textAlign: "left" }}>
        *string*
      </td>

      <td style={{ textAlign: "left" }}>
        Optional
      </td>

      <td style={{ textAlign: "left" }}>
        Coupon code.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        `next-charge-date`
      </td>

      <td style={{ textAlign: "left" }}>
        *date*
      </td>

      <td style={{ textAlign: "left" }}>
        Optional
      </td>

      <td style={{ textAlign: "left" }}>
        Next charge date of the subscription.\
        Format: DD-MMM-YY
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        `auto-renew`
      </td>

      <td style={{ textAlign: "left" }}>
        *boolean*
      </td>

      <td style={{ textAlign: "left" }}>
        Optional
      </td>

      <td style={{ textAlign: "left" }}>
        Determines whether the subscription will be automatically renewed.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        `quantity`
      </td>

      <td style={{ textAlign: "left" }}>
        integer
      </td>

      <td style={{ textAlign: "left" }}>
        Optional
      </td>

      <td style={{ textAlign: "left" }}>
        Determines the quantity of the subscription to which the shopper is subscribed.  

        Value must be greater than zero.
      </td>
    </tr>
  </tbody>
</Table>

### Response

<Table align={["left","left","left"]}>
  <thead>
    <tr>
      <th>
        Property Name
      </th>

      <th>
        Type
      </th>

      <th>
        Description
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        `subscription-id`
      </td>

      <td>
        *string*
      </td>

      <td>
        Subscription ID.
      </td>
    </tr>

    <tr>
      <td>
        `status`
      </td>

      <td>
        *string*
      </td>

      <td>
        Status of the subscription:  

        * **A** = Active  
        * **C** = Cancelled  
        * **D** = Declined
      </td>
    </tr>

    <tr>
      <td>
        `cancellation-reason`
      </td>

      <td>
        *string*
      </td>

      <td>
        Product name.
      </td>
    </tr>

    <tr>
      <td>
        `underlying-sku-id`
      </td>

      <td>
        *long*
      </td>

      <td>
        ID of the SKU (contract) that the subscription is attributed to.
      </td>
    </tr>

    <tr>
      <td>
        `underlying-sku-name`
      </td>

      <td>
        *string*
      </td>

      <td>
        Name of the SKU (contract) that the subscription is attributed to.
      </td>
    </tr>

    <tr>
      <td>
        `shopper-id`
      </td>

      <td>
        *long*
      </td>

      <td>
        BlueSnap's global ID for the shopper who purchased the subscription.
      </td>
    </tr>

    <tr>
      <td>
        `credit-card`
      </td>

      <td>
        container
      </td>

      <td>
        Container of [credit-card](https://developers.bluesnap.com/reference/credit-card) properties.
      </td>
    </tr>

    <tr>
      <td>
        `paypal`
      </td>

      <td>
        *string*
      </td>

      <td>
        Empty field to indicate the a PayPal charge, consists only of the tag.
      </td>
    </tr>

    <tr>
      <td>
        `paypal-subscription`
      </td>

      <td>
        container
      </td>

      <td>
        Container of [paypal-subscription](https://developers.bluesnap.com/reference/paypal-subscription) properties.
      </td>
    </tr>

    <tr>
      <td>
        `catalog-recurring-charge`
      </td>

      <td>
        container
      </td>

      <td>
        Container of [catalog-recurring-charge](https://developers.bluesnap.com/reference/catalog-recurring-charge) properties.
      </td>
    </tr>

    <tr>
      <td>
        `override-recurring-charge`
      </td>

      <td>
        container
      </td>

      <td>
        Container of [override-recurring-charge](https://developers.bluesnap.com/reference/override-recurring-charge) properties.
      </td>
    </tr>

    <tr>
      <td>
        `coupon`
      </td>

      <td>
        *string*
      </td>

      <td>
        Coupon code.
      </td>
    </tr>

    <tr>
      <td>
        `charge-frequency`
      </td>

      <td>
        *string*
      </td>

      <td>
        Payment frequency:  

        * **none**  
        * **once**  
        * **ondemand**  
        * **daily**  
        * **weekly**  
        * **biweekly**  
        * **monthly**  
        * **bimonthly**  
        * **quarterly**  
        * **semiannually**  
        * **annually**  
        * **biannually**  
        * **triannually**  
        * **upon\_demand**
      </td>
    </tr>

    <tr>
      <td>
        `next-charge-date`
      </td>

      <td>
        *date*
      </td>

      <td>
        Next charge date of the subscription.\
        Format: DD-MMM-YY
      </td>
    </tr>

    <tr>
      <td>
        `manual-recurring-info`
      </td>

      <td>
        container
      </td>

      <td>
        Container of [manual-recurring-info](https://developers.bluesnap.com/reference/manual-recurring-info) properties.
      </td>
    </tr>

    <tr>
      <td>
        `auto-renew`
      </td>

      <td>
        *boolean*
      </td>

      <td>
        Determines whether the subscription will be automatically renewed.
      </td>
    </tr>

    <tr>
      <td>
        `last-charge-result`
      </td>

      <td>
        container
      </td>

      <td>
        Container of [last-charge-result](https://developers.bluesnap.com/reference/last-charge-result) properties.
      </td>
    </tr>

    <tr>
      <td>
        `subscription-charges`
      </td>

      <td>
        container
      </td>

      <td>
        Container of [subscription-charges](https://developers.bluesnap.com/reference/subscription-charges) properties.
      </td>
    </tr>
  </tbody>
</Table>