Skip to navigation

Import subscription

View as Markdown

Import an active subscription into the CRM. Idempotent by ExternalSubscriptionId. If both VaultToken and ProcessorId are provided, a payment method is created and linked.

Authentication

Authorizationstring

Format: ApiKey <your_key>

Headers

Idempotency-KeystringRequiredformat: "uuid"
UUID to prevent duplicate POST operations

Request

This endpoint expects an object.
CustomerIdintegerRequired
ProductIdintegerRequired
AmountdoubleRequired
BillingIntervalDaysintegerRequired1-3650
Days between charges
NextChargeDatedatetimeRequired
SiteIdintegerOptional
TotalCyclesintegerOptionalDefaults to 0

Total charges to run. 0 = unlimited

ProcessorIdintegerOptional
VaultTokenstringOptional<=500 characters

Gateway vault token (NMI CustomerVaultID, Stripe cus_xxx, etc.)

ExternalSubscriptionIdstringOptional<=100 characters
External subscription ID for idempotency

Response

Subscription imported
StatusintegerOptional
SubscriptionIdintegerOptional