Create Subscription

Creates a new subscription for a customer.

Deprecated: Use provisionSubscriptionV2 instead.

Mutation

Mutation

mutation CreateSubscription($input: SubscriptionInput!) {
  createSubscription(subscription: $input) {
    subscriptionId
    status
    plan {
      refId
      displayName
    }
    startDate
  }
}

{
  "input": {
    "customerId": "customer-123",
    "planId": "plan-pro",
    "billingPeriod": "MONTHLY"
  }
}

{
  "data": {
    "createSubscription": {
      "subscriptionId": "sub-789",
      "status": "ACTIVE",
      "plan": {
        "refId": "plan-pro",
        "displayName": "Pro Plan"
      },
      "startDate": "2024-01-15T00:00:00Z"
    }
  }
}

Parameters

input · SubscriptionInput · required

Input for creating a subscription

Show properties

customerId · String · required

Customer reference ID

planId · String · required

Plan reference ID

billingPeriod · BillingPeriod

Billing period

addons · [SubscriptionAddonInput]

Addons to include

startDate · DateTime

Start date

Related Operations

• Provision Subscription - Recommended alternative