# Vindicia Subscribe — SaaS Knowledge Center

## Home

- [Vindicia Subscribe — SaaS Knowledge Center](https://docs.slm.m1amdocs.com/index.md): Vindicia Subscribe documentation for getting started, implementation, and compliance.

- [Guides (1527 pages)](https://docs.slm.m1amdocs.com/_llms/guides.txt): Documentation for Guides.

## APIs

### Subscribe OpenAPIs

- [Subscribe OpenAPIs](https://docs.slm.m1amdocs.com/portal/apis/subscribe-api.md): Subscribe REST API operations. Use the sidebar to open an operation.

#### Accounts

- [List all Accounts](https://docs.slm.m1amdocs.com/api-reference/accounts/list-all-accounts.md): Retrieves all Accounts.
- [Create an Account](https://docs.slm.m1amdocs.com/api-reference/accounts/create-an-account.md): Creates a new Account object in Subscribe. When creating an Account you can create its sub-objects such as Payment Methods.
- [Retrieves a specific Account](https://docs.slm.m1amdocs.com/api-reference/accounts/retrieves-a-specific-account.md): Retrieves a specific Account by your merchant set ID or the Subscribe generated VID.
- [Update a specific Account](https://docs.slm.m1amdocs.com/api-reference/accounts/update-a-specific-account.md): Update a specific Account. Any parameters provided will be updated, leaving other parameters unchanged.
- [Fetch All Child Accounts](https://docs.slm.m1amdocs.com/api-reference/accounts/fetch-all-child-accounts.md): Retrieves all child accounts for a specified parent account.
- [Add child account](https://docs.slm.m1amdocs.com/api-reference/accounts/add-child-account.md): Subscribe supports two-level account hierarchies for payment and reporting; that is, you may define parent and children accounts. A parent can have multiple children, but a child may have only one parent, and a child may not be a parent to another Account.
- [Retrive the child account](https://docs.slm.m1amdocs.com/api-reference/accounts/retrive-the-child-account.md): Retrive the child account.
- [Remove Child Account](https://docs.slm.m1amdocs.com/api-reference/accounts/remove-child-account.md): Remove parent relationship on a specified child account.
- [Fetch Account Family](https://docs.slm.m1amdocs.com/api-reference/accounts/fetch-account-family.md): Return the family of the specified account.
- [Fetch all Currency Credit Amount Changes](https://docs.slm.m1amdocs.com/api-reference/accounts/fetch-all-currency-credit-amount-changes.md): Fetch all Currency Credit Amount Changes for an Account.
- [Modify a Currency Credit](https://docs.slm.m1amdocs.com/api-reference/accounts/modify-a-currency-credit.md): Update an existing Currency Credit Amount, including incrementing/decrementing the amount or Revoking the remainder of the Credit. Using a CurrencyAmount Object, manipulate the amount by providing positive values to increase the credit amount, negative values to decrease the credit amount, or a nega…
- [Fetch Currency Credit Amount Change](https://docs.slm.m1amdocs.com/api-reference/accounts/fetch-currency-credit-amount-change.md): Fetch a specific Currency Credit Amount Change to see additional details of the adjustment to the Credit.
- [Fetch All Token Credit Amount Changes](https://docs.slm.m1amdocs.com/api-reference/accounts/fetch-all-token-credit-amount-changes.md): Fetch all Token Credit Amount Changes for an Account.
- [Modify a Token Credit](https://docs.slm.m1amdocs.com/api-reference/accounts/modify-a-token-credit.md): Update an existing Token Credit Amount, including incrementing/decrementing the amount or Revoking the remainder of the Credit. Using a TokenAmount Object manipulate the amount by providing positive values to increase the token credit amount, negative values to decrease the token credit amount, or a…
- [Fetch Token Credit Amount Change](https://docs.slm.m1amdocs.com/api-reference/accounts/fetch-token-credit-amount-change.md): Fetch a specific Token Amount Change to see additional details of the adjustment to the Credit.
- [Grant Entitlement](https://docs.slm.m1amdocs.com/api-reference/accounts/grant-entitlement.md): The grant Entitlement method grants an Account-level Entitlement to an Account.
- [Revoke Entitlement](https://docs.slm.m1amdocs.com/api-reference/accounts/revoke-entitlement.md): Revokes entitlement from an Account.

#### Cancel Reasons

- [List all Cancel Reasons](https://docs.slm.m1amdocs.com/api-reference/cancel-reasons/list-all-cancel-reasons.md): Retrieves all cancel reasons.
- [Create a Cancel Reason](https://docs.slm.m1amdocs.com/api-reference/cancel-reasons/create-a-cancel-reason.md): Creates a new Cancel Reason.
- [Fetch a Specific Cancel Reason](https://docs.slm.m1amdocs.com/api-reference/cancel-reasons/fetch-a-specific-cancel-reason.md): Retrieve a specific Cancel Reason.
- [Update a Cancel Reason](https://docs.slm.m1amdocs.com/api-reference/cancel-reasons/update-a-cancel-reason.md): Edit an existing cancel reason code or description

#### Reason Code

- [lists reason codes](https://docs.slm.m1amdocs.com/api-reference/reason-code/lists-reason-codes.md): System-defined and merchant-specified reasons for canceling or pausing a Subscription.
- [creates reason codes](https://docs.slm.m1amdocs.com/api-reference/reason-code/creates-reason-codes.md): Creates reason codes.
- [Fetch a Specific Reason Code](https://docs.slm.m1amdocs.com/api-reference/reason-code/fetch-a-specific-reason-code.md): Retrieve a specific Reason Code.
- [updates reason codes](https://docs.slm.m1amdocs.com/api-reference/reason-code/updates-reason-codes.md): Updates reason codes

#### Chargebacks

- [List All Chargebacks](https://docs.slm.m1amdocs.com/api-reference/chargebacks/list-all-chargebacks.md): Retrieves a list of all Chargebacks.
- [Report a Chargeback](https://docs.slm.m1amdocs.com/api-reference/chargebacks/report-a-chargeback.md): This method is rarely used, because Vindicia usually retrieves chargebacks directly from the bank or payment processor on the merchant’s behalf, and enters them into ChargeGuard. If your bank or payment processor does not allow Vindicia access to that information, you must retrieve the chargebacks y…
- [Fetch a Specific Chargeback](https://docs.slm.m1amdocs.com/api-reference/chargebacks/fetch-a-specific-chargeback.md): Retrieve a specific chargeback record.
- [Update a Chargeback](https://docs.slm.m1amdocs.com/api-reference/chargebacks/update-a-chargeback.md): Updates a specified Chargeback object. This method is rarely used, because Vindicia usually creates and updates chargebacks by retrieving them directly from your payment processor, and updating their status during the dispute process.

#### Payment Methods

- [List All Payment Methods](https://docs.slm.m1amdocs.com/api-reference/payment-methods/list-all-payment-methods.md): Retrieves Payment Methods filtered by Account.
- [Create a Payment Method](https://docs.slm.m1amdocs.com/api-reference/payment-methods/create-a-payment-method.md): Creates a new Payment Method object without association to a specific Account, or Subscription or Transaction.
- [Fetch a Specific Payment Method](https://docs.slm.m1amdocs.com/api-reference/payment-methods/fetch-a-specific-payment-method.md): Retrieves a specific Payment Method.
- [Update a Payment Method](https://docs.slm.m1amdocs.com/api-reference/payment-methods/update-a-payment-method.md): Update an existing Payment Method.

#### Products

- [List All Products](https://docs.slm.m1amdocs.com/api-reference/products/list-all-products.md): Retrieves all Product objects.
- [Create a Product](https://docs.slm.m1amdocs.com/api-reference/products/create-a-product.md): Creates a new Product object.
- [Fetch a Specific Product](https://docs.slm.m1amdocs.com/api-reference/products/fetch-a-specific-product.md): Retrieves a specific Product.
- [Update a Product](https://docs.slm.m1amdocs.com/api-reference/products/update-a-product.md): Update an existing product.

#### Rate Plans

- [List all Rate Plans](https://docs.slm.m1amdocs.com/api-reference/rate-plans/list-all-rate-plans.md): Retrieves all Rate plans
- [Create a New Rate Plan](https://docs.slm.m1amdocs.com/api-reference/rate-plans/create-a-new-rate-plan.md): Create a new Rate Plan object.
- [Fetch a Specific Rate Plan](https://docs.slm.m1amdocs.com/api-reference/rate-plans/fetch-a-specific-rate-plan.md): Retrieves a specific Rate Plan.
- [Update an Existing Rate Plan](https://docs.slm.m1amdocs.com/api-reference/rate-plans/update-an-existing-rate-plan.md): Update an existing RatePlan.

#### Events

- [List Events](https://docs.slm.m1amdocs.com/api-reference/events/list-events.md): Fetch a list of all events on an Account, Subscription, Product, or Rate Plan.
- [Record (Create) Events](https://docs.slm.m1amdocs.com/api-reference/events/record-create-events.md): Record one or more events.
- [Fetch an Event](https://docs.slm.m1amdocs.com/api-reference/events/fetch-an-event.md): Fetch a specific event detail.
- [Update or Edit an Event](https://docs.slm.m1amdocs.com/api-reference/events/update-or-edit-an-event.md): Edit an existing event.

#### Tokens

- [list Tokens](https://docs.slm.m1amdocs.com/api-reference/tokens/list-tokens.md): Retrieves all tokens
- [Creates Token](https://docs.slm.m1amdocs.com/api-reference/tokens/creates-token.md): Create a new token
- [fetch a specific Tokens](https://docs.slm.m1amdocs.com/api-reference/tokens/fetch-a-specific-tokens.md): Retrieves all tokens
- [Update a specific Token](https://docs.slm.m1amdocs.com/api-reference/tokens/update-a-specific-token.md): Updates a specific token

#### Address

- [creates address](https://docs.slm.m1amdocs.com/api-reference/address/creates-address.md): Creates addresses
- [fetch specific address](https://docs.slm.m1amdocs.com/api-reference/address/fetch-specific-address.md): Retrieve a specific address.
- [updates address](https://docs.slm.m1amdocs.com/api-reference/address/updates-address.md): Updates address

#### Season Sets

- [List All Season Sets](https://docs.slm.m1amdocs.com/api-reference/season-sets/list-all-season-sets.md): Retrieves all Season Sets.
- [Create a Season Set](https://docs.slm.m1amdocs.com/api-reference/season-sets/create-a-season-set.md): Creates a new Season Set Object.
- [Fetch a Specific Season Set](https://docs.slm.m1amdocs.com/api-reference/season-sets/fetch-a-specific-season-set.md): Retrieves a specific Season Set.
- [Update a Season Set](https://docs.slm.m1amdocs.com/api-reference/season-sets/update-a-season-set.md): Update a specific SeasonSet.
- [List Seasons](https://docs.slm.m1amdocs.com/api-reference/season-sets/list-seasons.md): Retrieves all seasons for a specified Season Set.

#### Invoices

- [List Invoices](https://docs.slm.m1amdocs.com/api-reference/invoices/list-invoices.md): Retrieves a list of Invoices (all or filtered). This can be used to get a cross-account list of invoices, or for a given subscription using the /"subscription/" query parameter (see example).
- [Fetch a Specific Invoice](https://docs.slm.m1amdocs.com/api-reference/invoices/fetch-a-specific-invoice.md): Retrieves a specific Invoice.
- [Write Off an Invoice](https://docs.slm.m1amdocs.com/api-reference/invoices/write-off-an-invoice.md): Marks the invoice as written off meaning that the debt can't be collected.

#### Currency Amount

- [fetch currency amount](https://docs.slm.m1amdocs.com/api-reference/currency-amount/fetch-currency-amount.md): The CurrencyAmount object represents the currency credit detail associated with a particular grant of currency credits.

#### Transactions

- [List All Transactions](https://docs.slm.m1amdocs.com/api-reference/transactions/list-all-transactions.md): Retrieves all transactions. To limit the potentially large return size, it is recommended that the account or subscription query parameters be used to filter, in addition to pagination.
- [Create a Transaction (Authorization)](https://docs.slm.m1amdocs.com/api-reference/transactions/create-a-transaction-authorization.md): Posting with a new Transaction creates a new one-time Transaction object.
- [Fetch a Specific Transaction](https://docs.slm.m1amdocs.com/api-reference/transactions/fetch-a-specific-transaction.md): Retrieves the specified Transaction.
- [Cancel a Transaction](https://docs.slm.m1amdocs.com/api-reference/transactions/cancel-a-transaction.md): Cancel a Transaction which has not yet been captured.
- [Capture a Transaction](https://docs.slm.m1amdocs.com/api-reference/transactions/capture-a-transaction.md): Capture an authorized Transaction. Note- you can also have a transaction captured (complete charge) during creation – see “Create a Transaction”.
- [Finish a Transaction](https://docs.slm.m1amdocs.com/api-reference/transactions/finish-a-transaction.md): Finish a Transaction action is used when the transaction was put in an AuthorizationPending status and the Transaction can now be completed. This call is relevant for PayPal flow, carrier billing, and for 3DS implementation.
- [Calculate the risk score](https://docs.slm.m1amdocs.com/api-reference/transactions/calculate-the-risk-score.md): Calculate the risk score or chargeback probability score for this Transaction object.

#### Refunds

- [List All Refunds](https://docs.slm.m1amdocs.com/api-reference/refunds/list-all-refunds.md): Retrieves a list of all Refunds associated with either an account or transaction. There are two supported methods for an API call :- * Refunds Endpoint * Transactions Endpoint
- [Creates Refund](https://docs.slm.m1amdocs.com/api-reference/refunds/creates-refund.md): Creates a new Refund against an existing transaction. There are two supported methods for an API call: * Refunds Endpoint * Transactions Endpoint
- [fetch a specific Refunds](https://docs.slm.m1amdocs.com/api-reference/refunds/fetch-a-specific-refunds.md): Retrieves a specific Refund. There are two supported methods for an API call: * Refunds Endpoint * Transactions Endpoint

#### Entitlements

- [List Entitlements](https://docs.slm.m1amdocs.com/api-reference/entitlements/list-entitlements.md): Retrieves a list of filtered Entitlements. The list must be constrained to a particular Account (or Account family), or by Entitlement **id**.
- [Create an Entitlement](https://docs.slm.m1amdocs.com/api-reference/entitlements/create-an-entitlement.md): Creates a new Entitlement object using an id and description.

#### Activities

- [List All Activities](https://docs.slm.m1amdocs.com/api-reference/activities/list-all-activities.md): Retrieves filtered list of recorded activities.
- [Create an Activity (Record)](https://docs.slm.m1amdocs.com/api-reference/activities/create-an-activity-record.md): Report non-transaction activities to Vindicia.
- [Fetch a Specific Activity Record](https://docs.slm.m1amdocs.com/api-reference/activities/fetch-a-specific-activity-record.md): Retrieve a specific activity record.

#### Billing Plans

- [List all Billing Plans](https://docs.slm.m1amdocs.com/api-reference/billing-plans/list-all-billing-plans.md): Retrieves all Billing Plans.
- [Create a Billing Plan](https://docs.slm.m1amdocs.com/api-reference/billing-plans/create-a-billing-plan.md): Creates a new Billing Plan object.
- [Fetch a Specific Billing Plan](https://docs.slm.m1amdocs.com/api-reference/billing-plans/fetch-a-specific-billing-plan.md): Retrieves a specific Billing Plan.
- [Update a Billing Plan](https://docs.slm.m1amdocs.com/api-reference/billing-plans/update-a-billing-plan.md): Update a specific Billing Plan.

#### Event Summary

- [list event summary](https://docs.slm.m1amdocs.com/api-reference/event-summary/list-event-summary.md): The Event Summary object defines (temporary) charges for a single Subscription Item and related information about the Item to which these charges refer. It is used to get a list of unbilled Event Summaries according to a rate plan.

#### Charges

- [List All Charges](https://docs.slm.m1amdocs.com/api-reference/charges/list-all-charges.md): Retrieves all non-recurring Charges for a given Subscription or Invoice created through the Create Charge call.
- [Create a Pending Charge](https://docs.slm.m1amdocs.com/api-reference/charges/create-a-pending-charge.md): Creates a new non-recurring pending charge on a given Subscription or Invoice.
- [Fetch a Specific Charge](https://docs.slm.m1amdocs.com/api-reference/charges/fetch-a-specific-charge.md): Retrieves a specific Charge that was created through the Create Charge call.

#### Cancel Fee Policy

- [Lists cancel fee policies](https://docs.slm.m1amdocs.com/api-reference/cancel-fee-policy/lists-cancel-fee-policies.md): Retrieves list of cancel fee policies.
- [Fetch specific cancel fee policy](https://docs.slm.m1amdocs.com/api-reference/cancel-fee-policy/fetch-specific-cancel-fee-policy.md): Retrieve a specific cancel fee policy.

#### Diagnostics

- [list diagnostics](https://docs.slm.m1amdocs.com/api-reference/diagnostics/list-diagnostics.md): Retrieves all diagnostics objects.
- [fetch diagnostics product](https://docs.slm.m1amdocs.com/api-reference/diagnostics/fetch-diagnostics-product.md): Retrieves a specific diagnostics.

#### Campaigns

- [List All Campaigns](https://docs.slm.m1amdocs.com/api-reference/campaigns/list-all-campaigns.md): Retrieves all Campaigns.
- [Create a Campaign](https://docs.slm.m1amdocs.com/api-reference/campaigns/create-a-campaign.md): Creates a new Campaign.
- [Fetch a Specific Campaign](https://docs.slm.m1amdocs.com/api-reference/campaigns/fetch-a-specific-campaign.md): Retrieves a specific campaign.
- [Update a Campaign.](https://docs.slm.m1amdocs.com/api-reference/campaigns/update-a-campaign.md): Update a specific Campaign.
- [Generate Incremental Coupon Codes](https://docs.slm.m1amdocs.com/api-reference/campaigns/generate-incremental-coupon-codes.md): Generates additional coupon codes, on demand. Available when the coupon campaign is already active.
- [Activate a Specific Campaign.](https://docs.slm.m1amdocs.com/api-reference/campaigns/activate-a-specific-campaign.md): Activates a specific Campaign.
- [Deactivate a Specific Campaign](https://docs.slm.m1amdocs.com/api-reference/campaigns/deactivate-a-specific-campaign.md): Deactivates a specific Campaign.
- [Cancel a Specific Campaign](https://docs.slm.m1amdocs.com/api-reference/campaigns/cancel-a-specific-campaign.md): Cancels a specific Campaign.
- [Mark All Coupons Used](https://docs.slm.m1amdocs.com/api-reference/campaigns/mark-all-coupons-used.md): Bulk operation that marks all unused coupon codes under a campaign as used.

#### Campaign Codes

- [Fetch a Specific Campaign Code](https://docs.slm.m1amdocs.com/api-reference/campaign-codes/fetch-a-specific-campaign-code.md): Retrieves a specific Campaign Code.
- [Validate a Coupon Code](https://docs.slm.m1amdocs.com/api-reference/campaign-codes/validate-a-coupon-code.md): Validate a specific coupon code to check if the coupon is valid and active
- [Activate a Coupon Code](https://docs.slm.m1amdocs.com/api-reference/campaign-codes/activate-a-coupon-code.md): Activate a specific Coupon Code. This is an additional security step that allows to activate the coupon codes after they were generated.

#### Payments

- [List All Payments](https://docs.slm.m1amdocs.com/api-reference/payments/list-all-payments.md): Retrieves all Payment objects.
- [Create a Payment](https://docs.slm.m1amdocs.com/api-reference/payments/create-a-payment.md): Creates a new payment object.
- [fetch a specific payment](https://docs.slm.m1amdocs.com/api-reference/payments/fetch-a-specific-payment.md): Retrieves a specific payment by the payment ID
- [Reverse a payment](https://docs.slm.m1amdocs.com/api-reference/payments/reverse-a-payment.md): Reverse a payment action can be used to reverse payments made using the create a payment call and is only applicable for payments made using the Merchant Accepted Payment payment method. When the payment is reversed, status appears as Failure. The associated Transaction will be in TransactionStatus…

#### Subscription

- [List (All) Subscriptions](https://docs.slm.m1amdocs.com/api-reference/subscription/list-all-subscriptions.md): Retrieves a list of Subscriptions. This can be used to get a list of subscriptions for a given account using the “account” query parameter.
- [Create a Subscription](https://docs.slm.m1amdocs.com/api-reference/subscription/create-a-subscription.md): Creates a new Subscription object.
- [Fetch a Specific Subscription](https://docs.slm.m1amdocs.com/api-reference/subscription/fetch-a-specific-subscription.md): Retrieves a specific Subscription.
- [Modify a Subscription (Update)](https://docs.slm.m1amdocs.com/api-reference/subscription/modify-a-subscription-update.md): Update, amend, or modify a Subscription. See Vindicia Knowledgebase regarding various modify scenarios and additional approaches. REST approaches for the most common modifications are below (see “Accepts” section for this operation). * Billing Plan Change * Add or Remove a Subscription Item * Replac…
- [Cancel a Subscription](https://docs.slm.m1amdocs.com/api-reference/subscription/cancel-a-subscription.md): Cancel a subscription, with options to select immediate disentitlement versus registering the cancel now to take affect at the end of the current period; to select whether any pre-paid services should get a prorated refund; and to select whether or not an existing minimum commitment should be honore…
- [Activate a Specific Subscription](https://docs.slm.m1amdocs.com/api-reference/subscription/activate-a-specific-subscription.md): Activate a specific Subscription in status Pending Activation that has a future or unknown start date.
- [Add DiscountTicket to a Subscription](https://docs.slm.m1amdocs.com/api-reference/subscription/add-discountticket-to-a-subscription.md): Add DiscountTicket to a Subscription. Only supported for Stackable Discounts.
- [Add Campaign Code to a Subscription](https://docs.slm.m1amdocs.com/api-reference/subscription/add-campaign-code-to-a-subscription.md): Apply a campaign code to an existing subscription. The campaign code can be a promotion code or a coupon code. The campaign code can be applied to all the subscription items or to specific ones. For more details, see Campaign Codes. Only supported for Single Discount.
- [Change the Subscription's Billing Day](https://docs.slm.m1amdocs.com/api-reference/subscription/change-the-subscriptions-billing-day.md): Change the standard billing day of the month assigned to a subscription. Commonly referred to as the “anniversary day” or “billing day” - this value is an integer between 1 and 31 representing which day of the month is used for any recurring billing based on some number of months in term. While not…
- [Fetch Subscription Item History](https://docs.slm.m1amdocs.com/api-reference/subscription/fetch-subscription-item-history.md): Retrieves the SubscriptionItem history for a specified subscription.
- [Fetch Billing Plan History](https://docs.slm.m1amdocs.com/api-reference/subscription/fetch-billing-plan-history.md): Retrieves the BillingPlan history for a specified subscription.
- [Fetch Currency Credit Amount Change](https://docs.slm.m1amdocs.com/api-reference/subscription/fetch-currency-credit-amount-change.md): Fetch a specific Currency Credit Amount Change to see additional details of the adjustment to the Credit.
- [Fetch all Currency Credit Amount Changes](https://docs.slm.m1amdocs.com/api-reference/subscription/fetch-all-currency-credit-amount-changes.md): Fetch all Currency Credit Amount Changes for an Account.
- [Grant or Revoke Currency Credit](https://docs.slm.m1amdocs.com/api-reference/subscription/grant-or-revoke-currency-credit.md): Grant, Revoke, increment or decrement an Subscription Level Currency Credit.
- [Fetch All Token Credit Amount Changes](https://docs.slm.m1amdocs.com/api-reference/subscription/fetch-all-token-credit-amount-changes.md): Fetch all Token Credit Amount Changes for an Subscription.
- [Grant or Revoke Token Credit](https://docs.slm.m1amdocs.com/api-reference/subscription/grant-or-revoke-token-credit.md): Grant, Revoke, increment or decrement an Subscription Level Token Credit.
- [Fetch a specific Token Credit Amount Changes](https://docs.slm.m1amdocs.com/api-reference/subscription/fetch-a-specific-token-credit-amount-changes.md): Fetch a specific Token Credit Amount Change to see additional details of the adjustment to the Credit.
- [Fetch Future Transactions](https://docs.slm.m1amdocs.com/api-reference/subscription/fetch-future-transactions.md): Retrieves the future Transactions for a specified subscription. The number of future transactions desired is required as part of the call.
- [Pause a Subscription](https://docs.slm.m1amdocs.com/api-reference/subscription/pause-a-subscription.md): Pause billing for an existing Subscription at the beginning of the next billing cycle (default) or immediately with an optional reason for the pause. If no other action is taken upon the Subscription, it will remain paused for 5 years, and then cancel.
- [Resume a Subscription](https://docs.slm.m1amdocs.com/api-reference/subscription/resume-a-subscription.md): Resume a previously paused Subscription.

#### Gift Cards

- [Fetch Status of a Specific Gift Card](https://docs.slm.m1amdocs.com/api-reference/gift-cards/fetch-status-of-a-specific-gift-card.md): Retrieves the status of a gift card previously created in Subscribe by a gift call redemption or a gift card call.
- [Create a Gift Card](https://docs.slm.m1amdocs.com/api-reference/gift-cards/create-a-gift-card.md): Creates a new Gift Card object in Subscribe. The gift card itself is created in the system but the Gift card's value is not redeemed and therefore is not available for consumption.

#### Gift Card Redemptions

- [List (All) Gift Card Redemptions](https://docs.slm.m1amdocs.com/api-reference/gift-card-redemptions/list-all-gift-card-redemptions.md): Retrieves a list of Gift Card Redemptions per customer account using the account query parameter.
- [Create a Gift Card Redemption](https://docs.slm.m1amdocs.com/api-reference/gift-card-redemptions/create-a-gift-card-redemption.md): Creates a new Gift Card redemption object in Subscribe. It also creates its associated objects such as a gift card object and the account's credit object. The customer's account must exist in the system prior to redemption.
- [Fetch a Specific Gift Card Redemption](https://docs.slm.m1amdocs.com/api-reference/gift-card-redemptions/fetch-a-specific-gift-card-redemption.md): Retrieves a specific giftcard redemptions.
- [Reverse a Gift Card Redemption](https://docs.slm.m1amdocs.com/api-reference/gift-card-redemptions/reverse-a-gift-card-redemption.md): Reverses a Gift Card redemption thereby returning the funds to the Gift Card from the customer's account.

#### Discount Tickets

- [List All Discount Tickets](https://docs.slm.m1amdocs.com/api-reference/discount-tickets/list-all-discount-tickets.md): Retrieves a list of Discount Tickets. This can be used to get a list of Discount Tickets per a Subscription or per a given Account. Only supported for Stackable Discounts.

#### GDPR Erase

- [Cleans personal info for GDPR Compliance.](https://docs.slm.m1amdocs.com/api-reference/gdpr-erase/cleans-personal-info-for-gdpr-compliance.md): Erases personal information from an account for GDPR compliance.A single account can be entered per call. You must provide account_id in body.

### Connect Activation OpenAPIs

- [Connect Activation OpenAPIs](https://docs.slm.m1amdocs.com/portal/apis/connect-activation.md): User activation flows. Use the sidebar to open an operation.

#### user

- [Delete a user specified by a user attribute (Machine-to-Machine)](https://docs.slm.m1amdocs.com/api-reference/user/delete-a-user-specified-by-a-user-attribute-machine-to-machine.md): Deletes the user specified by the attributeName and attributeValue parameters. Also deletes any associations that the user has with other Connect entities.
- [Update a user’s status using a specific user attribute (Machine-to-Machine)](https://docs.slm.m1amdocs.com/api-reference/user/update-a-user’s-status-using-a-specific-user-attribute-machine-to-machine.md): Changes the status of the Connect user specified by attributeName and attributeValue.
- [Post activationadduser](https://docs.slm.m1amdocs.com/api-reference/user/post-activationadduser.md): Creates new User.<br><br>Mandatory Fields:<br>- authnIdentifiers value - email or mobile number of the user<br>- authnIdentifiers primary - must always be set to true<br><br>Optional Fields:<br>- displayName<br>- firstName<br>- lastName<br>- authnIdentifers mfaEnabled - when the value is set to true…

## OpenAPI Specs

- [SubscribeAPI](/portal/SubscribeAPI.yaml)
- [ConnectActivationAPI](/portal/ConnectActivationAPI.yaml)

> The links below point to documentation indexes. Follow each `/_llms/` index recursively until you reach documentation pages.

## Indexes

- [Guides (1527 pages)](https://docs.slm.m1amdocs.com/_llms/guides.txt): Documentation for Guides.
- [Guides / Merchant Portal 2.0 User Guide (209 pages)](https://docs.slm.m1amdocs.com/_llms/guides/merchant-portal-2-0-user-guide.txt): Documentation for Guides / Merchant Portal 2.0 User Guide.
- [Guides / REST API Reference Guide (325 pages)](https://docs.slm.m1amdocs.com/_llms/guides/rest-api-reference-guide.txt): Documentation for Guides / REST API Reference Guide.
- [Guides / SOAP API Guide (323 pages)](https://docs.slm.m1amdocs.com/_llms/guides/soap-api-guide.txt): Documentation for Guides / SOAP API Guide.
- [Guides / SOAP Programming Guide (186 pages)](https://docs.slm.m1amdocs.com/_llms/guides/soap-programming-guide.txt): Documentation for Guides / SOAP Programming Guide.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.