createSubscription
Creates a new subscription and returns payment redirection URLs.
Arguments
| Argument | Description |
|---|---|
Parameters for CreateSubscription |
CreateSubscriptionInput Arguments
| Argument | Description |
|---|---|
Metadata that can be used by developers to store additional information on objects. | |
The token of the subscription to update, or creates a new one if one doesn't exist. | |
The company name of the customer. | |
The company VAT number. | |
The customer's salutation (mr,ms,mx). | |
The customer's first name. | |
The customer's last name. | |
The customer's address line or street. | |
The customer's zip code or postal code. | |
The customer's house, building, or appartment number. | |
The customer's city or town. | |
The customer's country code (ISO3661). | |
The customer's state or province (ISO3661-2). | |
The customer's district. | |
The customer's phone number (international format). | |
The customer's date of birth (yyyy-mm-dd). | |
Whether billing and shipping addresses are the same. Set this flag to `true` to store a separate billing address. | |
The company name of the customer's billing address. | |
The customer's billing address salutation (mr,ms,mx). | |
The customer's billing address first name. | |
The customer's billing address last name. | |
The customer's billing address address line or street. | |
The customer's billing address zip code or postal code. | |
The customer's billing address house, building, or appartment number. | |
The customer's billing address city or town. | |
The customer's billing address country code (ISO3661). | |
The customer's billing address state or province (ISO3661-2). | |
The customer's billing address district. | |
The customer's billing address phone number (international format). | |
The customer's email address. | |
Whether the customer accepted the terms and conditions. | |
Whether the customer accepted optional marketing communication opt-in. | |
Extra field values for the subscription. | |
The customer's language/locale. Must be enabled on the project. | |
Don't automatically activate the subscription on signup. | |
The day of the month when the customer is charged. | |
The number of months before the customer is charged for the first time. | |
The field that can be used for your internal reference. For example, internal customer id. | |
The current status of the subscription. (default: inactive) | |
The time when the signup was completed. | |
The time the subscription was activated. | |
The time the subscription was (fully) cancelled. | |
The time the subscription started the cancellation process (with two-step cancellation) | |
Time time the subscription was marked as non-paying. | |
The Mollie Customer ID (cst_XXX) | |
The Stripe Customer ID (cus_XXX) | |
The Stripe Payment Method ID of the active payment method to charge. (pm_XXX) | |
The Adyen shopper reference being used for charges. | |
Specify a specific recurring payment reference, also requires the adyen payment method variant to be set. If either of them is not this field will be ignored | |
Specify a specific recurring payment method, also requires the adyen payment reference to be set. If either of them is not this field will be ignored | |
Unique ID for an imported subscription. | |
Notes specific for this subscription | |
Additional payment service provider specific properties used for payment creation. | |
The ID of the service channel to use for this subscription. | |
The products to subscribe to | |
Moment when the next billing cycle will be run, only available for plan based subscription that use the flexible biling cycle | |
The URL the customer gets redirected to when signup or initial payment was succesful. can be left blank to use the Firmhouse order confirmation page. | |
The URL of the page where your customer can re-initiate the checkout flow if something fails. | |
The plan the customer will subscribe to. | |
Discount code to apply when signing up |
Return fields
errors ([ModelValidationError!]!)
payment (Payment)
The initial payment object associated with signing up this subscription.
Deprecated: Will be removed.
paymentUrl (String)
The URL to redirect your customer to to complete the signup payment
returnUrl (String)
The passed value or a URL to the Firmhouse order confirmation page.
subscription (Subscription)
Deprecated: Will be removed. Use the 'subscription' field instead.
Last updated