# createSubscription ### Arguments | Argument | Description | | ------------------------------------------------------------------------------------------------------------------------------- | --------------------------------- | | input ([CreateSubscriptionInput](https://developer.firmhouse.com/graphql-api/api-reference/objects/create-subscription-input)!) | Parameters for CreateSubscription | ### CreateSubscriptionInput Arguments | Argument | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | | metadata ([JSON](https://developer.firmhouse.com/graphql-api/api-reference/objects/json)) | Metadata that can be used by developers to store additional information on objects. | | token ([ID](https://developer.firmhouse.com/graphql-api/api-reference/objects/id)) | The token of the subscription to update, or creates a new one if one doesn't exist. | | companyName ([String](https://developer.firmhouse.com/graphql-api/api-reference/objects/string)) | The company name of the customer. | | vatNumber ([String](https://developer.firmhouse.com/graphql-api/api-reference/objects/string)) | The company VAT number. | | salutation ([String](https://developer.firmhouse.com/graphql-api/api-reference/objects/string)) | The customer's salutation (mr,ms,mx). | | name ([String](https://developer.firmhouse.com/graphql-api/api-reference/objects/string)) | The customer's first name. | | lastName ([String](https://developer.firmhouse.com/graphql-api/api-reference/objects/string)) | The customer's last name. | | address ([String](https://developer.firmhouse.com/graphql-api/api-reference/objects/string)) | The customer's address line or street. | | address2 ([String](https://developer.firmhouse.com/graphql-api/api-reference/objects/string)) | The customer's second address line for additional information. | | zipcode ([String](https://developer.firmhouse.com/graphql-api/api-reference/objects/string)) | The customer's zip code or postal code. | | houseNumber ([String](https://developer.firmhouse.com/graphql-api/api-reference/objects/string)) | The customer's house, building, or appartment number. | | city ([String](https://developer.firmhouse.com/graphql-api/api-reference/objects/string)) | The customer's city or town. | | country ([String](https://developer.firmhouse.com/graphql-api/api-reference/objects/string)) | The customer's country code (ISO3661). | | state ([String](https://developer.firmhouse.com/graphql-api/api-reference/objects/string)) | The customer's state or province (ISO3661-2). | | district ([String](https://developer.firmhouse.com/graphql-api/api-reference/objects/string)) | The customer's district. | | phoneNumber ([String](https://developer.firmhouse.com/graphql-api/api-reference/objects/string)) | The customer's phone number (international format). | | dateOfBirth ([ISO8601Date](https://developer.firmhouse.com/graphql-api/api-reference/objects/iso-8601-date)) | The customer's date of birth (yyyy-mm-dd). | | shippingNotes ([String](https://developer.firmhouse.com/graphql-api/api-reference/objects/string)) | The customer's shipping notes (delivery instructions). | | differentBillingAddress ([Boolean](https://developer.firmhouse.com/graphql-api/api-reference/objects/boolean)) | Whether billing and shipping addresses are the same. Set this flag to \`true\` to store a separate billing address. | | billToCompanyName ([String](https://developer.firmhouse.com/graphql-api/api-reference/objects/string)) | The company name of the customer's billing address. | | billToSalutation ([String](https://developer.firmhouse.com/graphql-api/api-reference/objects/string)) | The customer's billing address salutation (mr,ms,mx). | | billToName ([String](https://developer.firmhouse.com/graphql-api/api-reference/objects/string)) | The customer's billing address first name. | | billToLastName ([String](https://developer.firmhouse.com/graphql-api/api-reference/objects/string)) | The customer's billing address last name. | | billToAddress ([String](https://developer.firmhouse.com/graphql-api/api-reference/objects/string)) | The customer's billing address address line or street. | | billToAddress2 ([String](https://developer.firmhouse.com/graphql-api/api-reference/objects/string)) | The customer's billing address second address line for additional information. | | billToZipcode ([String](https://developer.firmhouse.com/graphql-api/api-reference/objects/string)) | The customer's billing address zip code or postal code. | | billToHouseNumber ([String](https://developer.firmhouse.com/graphql-api/api-reference/objects/string)) | The customer's billing address house, building, or appartment number. | | billToCity ([String](https://developer.firmhouse.com/graphql-api/api-reference/objects/string)) | The customer's billing address city or town. | | billToCountry ([String](https://developer.firmhouse.com/graphql-api/api-reference/objects/string)) | The customer's billing address country code (ISO3661). | | billToState ([String](https://developer.firmhouse.com/graphql-api/api-reference/objects/string)) | The customer's billing address state or province (ISO3661-2). | | billToDistrict ([String](https://developer.firmhouse.com/graphql-api/api-reference/objects/string)) | The customer's billing address district. | | billToPhoneNumber ([String](https://developer.firmhouse.com/graphql-api/api-reference/objects/string)) | The customer's billing address phone number (international format). | | email ([String](https://developer.firmhouse.com/graphql-api/api-reference/objects/string)) | The customer's email address. | | termsAccepted ([Boolean](https://developer.firmhouse.com/graphql-api/api-reference/objects/boolean)) | Whether the customer accepted the terms and conditions. | | marketingOptIn ([Boolean](https://developer.firmhouse.com/graphql-api/api-reference/objects/boolean)) | Whether the customer accepted optional marketing communication opt-in. | | extraFields (\[[ExtraFieldInput](https://developer.firmhouse.com/graphql-api/api-reference/objects/extra-field-input)!]) | Extra field values for the subscription. | | locale ([String](https://developer.firmhouse.com/graphql-api/api-reference/objects/string)) | The customer's language/locale. Must be enabled on the project. | | skipAutoActivationOnSignup ([Boolean](https://developer.firmhouse.com/graphql-api/api-reference/objects/boolean)) | Don't automatically activate the subscription on signup. | | chargeDayOfTheMonth ([Int](https://developer.firmhouse.com/graphql-api/api-reference/objects/int)) | The day of the month when the customer is charged. | | trialPeriodMonths ([Int](https://developer.firmhouse.com/graphql-api/api-reference/objects/int)) | The number of months before the customer is charged for the first time. | | customerReference ([String](https://developer.firmhouse.com/graphql-api/api-reference/objects/string)) | The field that can be used for your internal reference. For example, internal customer id. | | status ([SubscriptionStatus](https://developer.firmhouse.com/graphql-api/api-reference/objects/subscription-status)) | The current status of the subscription. (default: inactive) | | signupCompletedAt ([ISO8601DateTime](https://developer.firmhouse.com/graphql-api/api-reference/objects/iso-8601-date-time)) | The time when the signup was completed. | | activatedAt ([ISO8601DateTime](https://developer.firmhouse.com/graphql-api/api-reference/objects/iso-8601-date-time)) | The time the subscription was activated. | | cancelledAt ([ISO8601DateTime](https://developer.firmhouse.com/graphql-api/api-reference/objects/iso-8601-date-time)) | The time the subscription was (fully) cancelled. | | stoppedAt ([ISO8601DateTime](https://developer.firmhouse.com/graphql-api/api-reference/objects/iso-8601-date-time)) | The time the subscription was stopped. | | cancellationStartedAt ([ISO8601DateTime](https://developer.firmhouse.com/graphql-api/api-reference/objects/iso-8601-date-time)) | The time the subscription started the cancellation process (with two-step cancellation) | | markedAsNonPayingAt ([ISO8601DateTime](https://developer.firmhouse.com/graphql-api/api-reference/objects/iso-8601-date-time)) | Time time the subscription was marked as non-paying. | | mollieCustomerId ([String](https://developer.firmhouse.com/graphql-api/api-reference/objects/string)) | The Mollie Customer ID (cst\_XXX) | | stripeCustomerId ([String](https://developer.firmhouse.com/graphql-api/api-reference/objects/string)) | The Stripe Customer ID (cus\_XXX) | | stripePaymentMethodId ([String](https://developer.firmhouse.com/graphql-api/api-reference/objects/string)) | The Stripe Payment Method ID of the active payment method to charge. (pm\_XXX) | | adyenShopperReference ([String](https://developer.firmhouse.com/graphql-api/api-reference/objects/string)) | The Adyen shopper reference being used for charges. | | adyenRecurringDetailReference ([String](https://developer.firmhouse.com/graphql-api/api-reference/objects/string)) | 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 | | adyenPaymentMethodVariant ([AdyenPaymentMethodVariant](https://developer.firmhouse.com/graphql-api/api-reference/objects/adyen-payment-method-variant)) | 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 | | importedSubscriptionId ([String](https://developer.firmhouse.com/graphql-api/api-reference/objects/string)) | Unique ID for an imported subscription. | | notes ([String](https://developer.firmhouse.com/graphql-api/api-reference/objects/string)) | Notes specific for this subscription | | pspPaymentProperties ([JSON](https://developer.firmhouse.com/graphql-api/api-reference/objects/json)) | Additional payment service provider specific properties used for payment creation. | | serviceChannelId ([ID](https://developer.firmhouse.com/graphql-api/api-reference/objects/id)) | The ID of the service channel to use for this subscription. | | projectToken ([ID](https://developer.firmhouse.com/graphql-api/api-reference/objects/id)) | | | orderedProducts (\[[OrderedProductInput](https://developer.firmhouse.com/graphql-api/api-reference/objects/ordered-product-input)!]) | The products to subscribe to | | weChatOpenId ([String](https://developer.firmhouse.com/graphql-api/api-reference/objects/string)) | | | nextBillingDate ([ISO8601Date](https://developer.firmhouse.com/graphql-api/api-reference/objects/iso-8601-date)) | Moment when the next billing cycle will be run, only available for plan based subscription that use the flexible biling cycle | | returnUrl ([String](https://developer.firmhouse.com/graphql-api/api-reference/objects/string)) | 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. | | paymentPageUrl ([String](https://developer.firmhouse.com/graphql-api/api-reference/objects/string)!) | The URL of the page where your customer can re-initiate the checkout flow if something fails. | | planId ([ID](https://developer.firmhouse.com/graphql-api/api-reference/objects/id)) | The plan the customer will subscribe to. | | discountCode ([String](https://developer.firmhouse.com/graphql-api/api-reference/objects/string)) | Discount code to apply when signing up | ### Return fields #### errors (\[[ModelValidationError](https://developer.firmhouse.com/graphql-api/api-reference/objects/model-validation-error)!]!) #### payment ([Payment](https://developer.firmhouse.com/graphql-api/api-reference/objects/payment)) The initial payment object associated with signing up this subscription. #### ~~paymentToken (~~[~~ID~~](https://developer.firmhouse.com/graphql-api/api-reference/objects/id)~~)~~ *`Deprecated: Will be removed.`* #### paymentUrl ([String](https://developer.firmhouse.com/graphql-api/api-reference/objects/string)) The URL to redirect your customer to to complete the signup payment #### returnUrl ([String](https://developer.firmhouse.com/graphql-api/api-reference/objects/string)) The passed value or a URL to the Firmhouse order confirmation page. #### subscription ([Subscription](https://developer.firmhouse.com/graphql-api/api-reference/objects/subscription)) #### ~~subscriptionToken (~~[~~ID~~](https://developer.firmhouse.com/graphql-api/api-reference/objects/id)~~)~~ *`Deprecated: Will be removed. Use the 'subscription' field instead.`*