{"_id":"5bedd214812951004a2ad9b3","category":{"_id":"5bedd214812951004a2ad94a","version":"5bedd214812951004a2ad9df","project":"57336fd5a6a9c40e00e13a0b","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-07-27T10:22:06.636Z","from_sync":false,"order":7,"slug":"subscriptions","title":"Subscriptions"},"user":"560d5913af97231900938124","parentDoc":null,"project":"57336fd5a6a9c40e00e13a0b","version":{"_id":"5bedd214812951004a2ad9df","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"5bcf36ac4eaaa605217d94b8","createdAt":"2018-04-24T15:22:41.561Z","releaseDate":"2018-04-24T15:22:41.561Z","categories":["5bedd214812951004a2ad943","5bedd214812951004a2ad944","5bedd214812951004a2ad945","5bedd214812951004a2ad946","5bedd214812951004a2ad947","5bedd214812951004a2ad948","5bedd214812951004a2ad949","5bedd214812951004a2ad94a","5bedd214812951004a2ad94b","5bedd214812951004a2ad94c","5bedd214812951004a2ad94d","5bedd214812951004a2ad94e","5bedd214812951004a2ad94f","5bedd214812951004a2ad950","5bedd214812951004a2ad951"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"3.28 Release","version_clean":"8976.0.0-JSON","version":"8976-JSON"},"githubsync":"","__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-07-29T16:13:02.799Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"post","results":{"codes":[{"code":"","language":"text"}]},"settings":"57ee593a21ceb20e0061959e","auth":"optional","params":[],"url":"/recurring/subscriptions"},"isReference":false,"order":4,"body":"The Create Subscription request enables you to set up a subscription, which associates a shopper with a plan to bill on an ongoing basis.\n\nFor more information about working with subscriptions, see the [Subscriptions tutorial](doc:subscription-management#section-tutorial-subscriptions).\n[block:callout]\n{\n  \"type\": \"success\",\n  \"title\": \"Testing subscription charges in sandbox\",\n  \"body\": \"After creating a subscription in sandbox, you can simulate a recurring charge event and trigger associated IPNs, emails, and invoices. Visit the [Subscriptions Guide](/v8976-JSON/docs/subscription-management#section-testing-your-subscriptions) to learn how.\"\n}\n[/block]\n<a class=\"btn btn-success\" href=\"#section-api-explorer\" role=\"button\">Try it in the API Explorer</a>\n\n###Request Content\n\nSend a **[subscription](doc:recurring-subscription)** object, with the following:\n\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`payerInfo` &nbsp;&nbsp;*object* &nbsp;&nbsp;optional - do not include if sending `vaultedShopperId` (see [payerInfo](doc:payer-info))\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`vaultedShopperId` &nbsp;&nbsp;*integer* &nbsp;&nbsp;optional - do not include if sending `payerInfo`\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`vendorInfo` *container* &nbsp;&nbsp;<span style=\"color:#F37500\">**required**</span> if using marketplace vendors (see [vendorInfo](doc:vendorinfo-1))\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`paymentSource` &nbsp;&nbsp;*object* &nbsp;&nbsp;<span style=\"color:#F37500\">**required** for `payerInfo`</span>; optional for `vaultedShopperId` (see [paymentSource](doc:payment-source))\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`authorizedByShopper` &nbsp;&nbsp;*boolean* &nbsp;&nbsp;<span style=\"color:#F37500\">**required**</span> for ACH/ECP and SEPA Direct Debit value must be **true**\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`overrideInitialChargeAmount` &nbsp;&nbsp;*decimal* &nbsp;&nbsp;optional\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`overrideRecurringChargeAmount` &nbsp;&nbsp;*decimal* &nbsp;&nbsp;optional\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`quantity` &nbsp;&nbsp;*integer* &nbsp;&nbsp;optional\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`overrideTrialPeriodDays` &nbsp;&nbsp;*integer* &nbsp;&nbsp;optional\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`softDescriptor` &nbsp;&nbsp;*string* &nbsp;&nbsp;optional\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`descriptorPhoneNumber` &nbsp;&nbsp;*string* &nbsp;&nbsp;optional\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`planId` &nbsp;&nbsp;*integer* &nbsp;&nbsp;&nbsp;<span style=\"color:#F37500\">**required**</span>\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`threeDSecure` &nbsp;&nbsp;*object* &nbsp;&nbsp;optional (see [threeDSecure](doc:threedsecure))\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`transactionFraudInfo` &nbsp;&nbsp;*object* &nbsp;&nbsp;optional (see [transactionFraudInfo](doc:transaction-fraud-info))\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`level3Data` &nbsp;&nbsp;*object* &nbsp;&nbsp;optional (see [level3Data](doc:level3data))\n\n###Response Details\nIf successful, the response HTTP status code is 200 OK.\nThe response contains the **[subscription](doc:recurring-subscription)** object.\nThe `subscriptionId` appears in the response body and the location header (unless ACH or SEPA DD was used).\n\n<hr>\n\n##Examples\n\n###Request Examples \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -v -X POST https://sandbox.bluesnap.com/services/2/recurring/subscriptions \\\\\\n-H 'Content-Type: application/json' \\\\\\n-H 'Accept: application/json' \\\\ \\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n{\\n    \\\"payerInfo\\\": {\\n        \\\"zip\\\": 12345,\\n        \\\"firstName\\\": \\\"John\\\",\\n        \\\"lastName\\\": \\\"Doe\\\",\\n        \\\"phone\\\": 1234567890\\n    },\\n    \\\"paymentSource\\\": {\\\"creditCardInfo\\\": {\\\"creditCard\\\": {\\n        \\\"expirationYear\\\": 2019,\\n        \\\"securityCode\\\": 111,\\n        \\\"expirationMonth\\\": \\\"07\\\",\\n        \\\"cardNumber\\\": 4111111111111111\\n    }}},\\n    \\\"planId\\\": 2283845,\\n    \\\"transactionFraudInfo\\\": {\\\"fraudSessionId\\\": 1234}\\n}'\",\n      \"language\": \"curl\",\n      \"name\": \"Create Subscription Request: with new shopper\"\n    },\n    {\n      \"code\": \"curl -v -X POST https://sandbox.bluesnap.com/services/2/recurring/subscriptions \\\\\\n-H 'Content-Type: application/json' \\\\\\n-H 'Accept: application/json' \\\\ \\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n{\\n    \\\"vaultedShopperId\\\": 20769005,\\n    \\\"overrideInitialChargeAmount\\\": 10.5,\\n    \\\"overrideRecurringChargeAmount\\\": 29.99,\\n    \\\"quantity\\\": 2,\\n    \\\"overrideTrialPeriodDays\\\": 10,\\n    \\\"softDescriptor\\\": \\\"Merchant name\\\",\\n    \\\"planId\\\": 2283845,\\n    \\\"transactionFraudInfo\\\": {\\n        \\\"shopperIpAddress\\\": \\\"123.12.134.1\\\",\\n        \\\"fraudSessionId\\\": 1234,\\n        \\\"company\\\": \\\"Company Name\\\",\\n        \\\"shippingContactInfo\\\": {\\n            \\\"zip\\\": 12345,\\n            \\\"country\\\": \\\"US\\\",\\n            \\\"firstName\\\": \\\"Doe\\\",\\n            \\\"lastName\\\": \\\"John\\\",\\n            \\\"city\\\": \\\"Juneau\\\",\\n            \\\"address2\\\": \\\"Apt 2\\\",\\n            \\\"address1\\\": \\\"1 Main St\\\",\\n            \\\"state\\\": \\\"AK\\\"\\n        }\\n    }\\n}\",\n      \"language\": \"curl\",\n      \"name\": \"with vaulted shopper and optional fields\"\n    },\n    {\n      \"code\": \"curl -v -X POST https://sandbox.bluesnap.com/services/2/recurring/subscriptions \\\\\\n-H 'Content-Type: application/json' \\\\\\n-H 'Accept: application/json' \\\\ \\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n{\\n    \\\"vaultedShopperId\\\": 20769005,\\n    \\\"paymentSource\\\": {\\\"creditCardInfo\\\": {\\\"creditCard\\\": {\\n        \\\"cardLastFourDigits\\\": 9299,\\n        \\\"cardType\\\": \\\"VISA\\\"\\n    }}},\\n    \\\"planId\\\": 2283845\\n}\",\n      \"language\": \"curl\",\n      \"name\": \"with vaulted shopper and specific payment method\"\n    },\n    {\n      \"code\": \"curl -v -X POST https://sandbox.bluesnap.com/services/2/recurring/subscriptions \\\\\\n-H 'Content-Type: application/json' \\\\\\n-H 'Accept: application/json' \\\\ \\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n{  \\n   \\\"payerInfo\\\":{  \\n      \\\"zip\\\":12345,\\n      \\\"firstName\\\":\\\"John\\\",\\n      \\\"lastName\\\":\\\"Doe\\\",\\n      \\\"phone\\\":1234567890\\n   },\\n   \\\"paymentSource\\\":{  \\n      \\\"creditCardInfo\\\":{  \\n         \\\"pfToken\\\":\\\"339110a75e2cdbb5f5f2cea8d7cd8af261ad7c89fb0ce1aae_\\\"\\n      }\\n   },\\n   \\\"planId\\\":2186278\\n}'\",\n      \"language\": \"curl\",\n      \"name\": \"with new shopper and hosted pay fields\"\n    },\n    {\n      \"code\": \"curl -v -X POST https://sandbox.bluesnap.com/services/2/recurring/subscriptions \\\\\\n-H 'Content-Type: application/json' \\\\\\n-H 'Accept: application/json' \\\\ \\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n{\\n    \\\"payerInfo\\\": {\\n        \\\"zip\\\": 12345,\\n        \\\"firstName\\\": \\\"John\\\",\\n        \\\"lastName\\\": \\\"Doe\\\",\\n        \\\"phone\\\": 1234567890\\n    },\\n    \\\"paymentSource\\\": {\\\"creditCardInfo\\\": {\\\"creditCard\\\": {\\n        \\\"expirationYear\\\": 2019,\\n        \\\"securityCode\\\": 111,\\n        \\\"expirationMonth\\\": \\\"07\\\",\\n        \\\"cardNumber\\\": 4111111111111111\\n    }}},\\n    \\\"planId\\\": 2283845,\\n    \\\"transactionFraudInfo\\\": {\\\"fraudSessionId\\\": 1234},\\n    \\\"vendorInfo\\\": {\\\"vendorId\\\": 541425}\\n}'\",\n      \"language\": \"curl\",\n      \"name\": \"with new shopper and vendor info\"\n    },\n    {\n      \"code\": \"curl -v -X POST https://sandbox.bluesnap.com/services/2/recurring/subscriptions \\\\\\n-H 'Content-Type: application/json' \\\\\\n-H 'Accept: application/json' \\\\ \\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n{\\n    \\\"planId\\\": 2283845,\\n    \\\"paymentSource\\\": {\\n      \\\"wallet\\\": {\\n        \\\"applePay\\\": { \\n          \\\"encodedPaymentToken\\\": \\\"ImRhdGEiO1AvRitIUy85Im9RbXhCMFd\\\" \\n        }\\n      }\\n    }\\n}'\",\n      \"language\": \"curl\",\n      \"name\": \"with Apple Pay\"\n    },\n    {\n      \"code\": \"curl -v -X POST https://sandbox.bluesnap.com/services/2/recurring/subscriptions \\\\\\n-H 'Content-Type: application/json' \\\\\\n-H 'Accept: application/json' \\\\ \\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n{\\n    \\\"planId\\\": 2283845,\\n    \\\"authorizedByShopper\\\": true,\\n    \\\"payerInfo\\\": {\\n        \\\"firstName\\\": \\\"John\\\",\\n        \\\"lastName\\\": \\\"Doe\\\",\\n        \\\"country\\\": \\\"fr\\\",\\n        \\\"zip\\\": \\\"12345\\\",\\n        \\\"phone\\\": \\\"1234567890\\\"\\n    },\\n    \\\"paymentSource\\\": {\\n        \\\"sepaDirectDebitInfo\\\": {\\n            \\\"sepaDirectDebit\\\": {\\n                \\\"iban\\\": \\\"DE09100100101234567893\\\"\\n            }\\n        }\\n    }\\n}'\",\n      \"language\": \"curl\",\n      \"name\": \"with SEPA Direct Debit \"\n    },\n    {\n      \"code\": \"curl -v -X POST https://sandbox.bluesnap.com/services/2/recurring/subscriptions \\\\\\n-H 'Content-Type: application/json' \\\\\\n-H 'Accept: application/json' \\\\ \\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n{\\n    \\\"planId\\\": 2380391,\\n    \\\"authorizedByShopper\\\": true,\\n    \\\"payerInfo\\\": {\\n        \\\"firstName\\\": \\\"Jane\\\",\\n        \\\"lastName\\\": \\\"Doe\\\",\\n        \\\"country\\\": \\\"us\\\",\\n        \\\"zip\\\": \\\"12345\\\",\\n        \\\"phone\\\": \\\"1234567890\\\"\\n    },\\n    \\\"paymentSource\\\": {\\n      \\\"ecpInfo\\\": {\\n        \\\"ecp\\\": {\\n          \\\"accountNumber\\\": 4099999992, \\n          \\\"routingNumber\\\": \\\"011075150\\\",\\n          \\\"accountType\\\": \\\"CONSUMER_CHECKING\\\"\\n        }\\n      }\\n   }\\n}'\",\n      \"language\": \"curl\",\n      \"name\": \"with ACH/ECP\"\n    },\n    {\n      \"code\": \"curl -v -X POST https://sandbox.bluesnap.com/services/2/recurring/subscriptions \\\\\\n-H 'Content-Type: application/json' \\\\\\n-H 'Accept: application/json' \\\\ \\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n{\\n    \\\"paymentSource\\\": {\\n        \\\"wallet\\\": {\\n           \\\"walletType\\\": \\\"GOOGLE_PAY\\\",\\n           \\\"encodedPaymentToken\\\": \\\"eyJwYXltZW50TWV0aG9kVG9rZW4iOnsilIjoiIn19\\\"\\n     }},\\n    \\\"planId\\\": 2283845,\\n    \\\"transactionFraudInfo\\\": {\\\"fraudSessionId\\\": 1234}\\n}'\",\n      \"language\": \"curl\",\n      \"name\": \"with Google Pay\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n###Response Examples\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"nextChargeDate\\\": \\\"2016-08-16\\\",\\n    \\\"quantity\\\": 1,\\n    \\\"charge\\\": {\\n        \\\"amount\\\": 100,\\n        \\\"vaultedShopperId\\\": 21188909,\\n        \\\"chargeInfo\\\": {\\n            \\\"fromDate\\\": \\\"2016-08-02\\\",\\n            \\\"toDate\\\": \\\"2016-08-16\\\",\\n            \\\"chargeType\\\": \\\"INITIAL\\\"\\n        },\\n        \\\"chargeId\\\": 12117877,\\n        \\\"paymentSource\\\": {\\\"creditCardInfo\\\": {\\\"creditCard\\\": {\\n            \\\"expirationYear\\\": 2019,\\n            \\\"cardLastFourDigits\\\": 1111,\\n            \\\"cardSubType\\\": \\\"CREDIT\\\",\\n            \\\"cardType\\\": \\\"VISA\\\",\\n            \\\"expirationMonth\\\": \\\"07\\\"\\n        }}},\\n        \\\"softDescriptor\\\": \\\"BLS&#x2a;default_descriptor\\\",\\n        \\\"planId\\\": 2283845,\\n        \\\"currency\\\": \\\"USD\\\",\\n        \\\"transactionDate\\\": \\\"2016-08-02\\\",\\n        \\\"subscriptionId\\\": 8492717,\\n        \\\"transactionId\\\": 1012463333\\n    },\\n    \\\"trialPeriodDays\\\": 14,\\n    \\\"paymentSource\\\": {\\\"creditCardInfo\\\": {\\n        \\\"billingContactInfo\\\": {\\n            \\\"firstName\\\": \\\"John\\\",\\n            \\\"lastName\\\": \\\"Doe\\\"\\n        },\\n        \\\"creditCard\\\": {\\n            \\\"expirationYear\\\": 2019,\\n            \\\"cardLastFourDigits\\\": 1111,\\n            \\\"cardSubType\\\": \\\"CREDIT\\\",\\n          \\t\\\"cardCategory\\\": \\\"CLASSIC\\\",\\n            \\\"cardType\\\": \\\"VISA\\\",\\n            \\\"expirationMonth\\\": \\\"07\\\"\\n        }\\n    }},\\n    \\\"softDescriptor\\\": \\\"BLS&#x2a;default_descriptor\\\",\\n    \\\"recurringChargeAmount\\\": 29.99,\\n    \\\"chargeFrequency\\\": \\\"MONTHLY\\\",\\n    \\\"vaultedShopperId\\\": 21188909,\\n    \\\"payerInfo\\\": {\\n        \\\"firstName\\\": \\\"John\\\",\\n        \\\"lastName\\\": \\\"Doe\\\"\\n    },\\n    \\\"initialChargeAmount\\\": 100,\\n    \\\"autoRenew\\\": true,\\n    \\\"planId\\\": 2283845,\\n    \\\"currency\\\": \\\"USD\\\",\\n    \\\"subscriptionId\\\": 8492717,\\n    \\\"fraudResultInfo\\\": {\\\"deviceDataCollector\\\": \\\"Y\\\"},\\n    \\\"status\\\": \\\"ACTIVE\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Create Subscription Response: 200 OK\"\n    },\n    {\n      \"code\": \"{\\n  \\\"subscriptionId\\\": 39565914,\\n  \\\"planId\\\": 2200594,\\n  \\\"vaultedShopperId\\\": 19608696,\\n  \\\"status\\\": \\\"ACTIVE\\\",\\n  \\\"quantity\\\": 1,\\n  \\\"softDescriptor\\\": \\\"BLS*default_descriptor\\\",\\n  \\\"chargeFrequency\\\": \\\"MONTHLY\\\",\\n  \\\"recurringChargeAmount\\\": 29.99,\\n  \\\"currency\\\": \\\"USD\\\",\\n  \\\"autoRenew\\\": \\\"true\\\",\\n  \\\"nextChargeDate\\\": \\\"2017-04-16\\\",\\n  \\\"payerInfo\\\": {\\n    \\\"firstName\\\": \\\"John\\\",\\n    \\\"lastName\\\": \\\"Doe\\\",\\n    \\\"zip\\\": \\\"12345\\\",\\n    \\\"phone\\\": \\\"1234567890\\\"\\n  },\\n  \\\"paymentSource\\\": {\\n    \\\"Wallet\\\": {\\n      \\\"billingContactInfo\\\": {\\n        \\\"firstName\\\": \\\"John\\\",\\n        \\\"lastName\\\": \\\"Doe\\\",\\n        \\\"address1\\\": \\\"South St\\\",\\n        \\\"city\\\": \\\"Waltham\\\",\\n        \\\"state\\\": \\\"MA\\\",\\n        \\\"zip\\\": \\\"02453\\\"\\n\\t\\t\\t},\\n      \\\"applePay\\\": {\\n        \\\"cardLastFourDigits\\\": \\\"0492\\\",\\n        \\\"cardType\\\": \\\"VISA\\\",\\n        \\\"cardSubType\\\": \\\"DEBIT\\\",\\n        \\\"dpanLastFourDigits\\\": \\\"4109\\\",\\n        \\\"dpanExpirationMonth\\\": \\\"11\\\",\\n        \\\"dpanExpirationYear\\\": \\\"25\\\"\\n      }\\n    }\\n  },\\n  \\\"charge\\\": {\\n    \\\"chargeId\\\": 235835,\\n    \\\"subscriptionId\\\": 39565914,\\n    \\\"planId\\\": 2200594,\\n    \\\"vaultedShopperId\\\": 19608696,\\n    \\\"transactionId\\\": 38548964,\\n    \\\"transactionDate\\\": \\\"2017-03-16\\\",\\n    \\\"amount\\\": 29.99,\\n    \\\"currency\\\": \\\"USD\\\",\\n    \\\"softDescriptor\\\": \\\"BLS*default_descriptor\\\",\\n    \\\"paymentSource\\\": {\\n      \\\"wallet\\\": {\\n        \\\"billingContactInfo\\\": {\\n          \\\"firstName\\\": \\\"John\\\",\\n          \\\"lastName\\\": \\\"Doe\\\",\\n          \\\"address1\\\": \\\"South St\\\",\\n          \\\"city\\\": \\\"Waltham\\\",\\n          \\\"state\\\": \\\"MA\\\",\\n          \\\"zip\\\": \\\"02453\\\"\\n        },\\n        \\\"applePay\\\": {\\n          \\\"cardLastFourDigits\\\": \\\"0492\\\",\\n          \\\"cardType\\\": \\\"VISA\\\",\\n\\t\\t\\t\\t\\t\\\"cardSubType\\\": \\\"DEBIT\\\",\\n          \\\"dpanLastFourDigits\\\": \\\"4109\\\",\\n          \\\"dpanExpirationMonth\\\": \\\"11\\\",\\n          \\\"dpanExpirationYear\\\": \\\"25\\\"\\n        }\\n      }\\n    },\\n    \\\"chargeInfo\\\": {\\n      \\\"fromDate\\\": \\\"2017-03-16\\\",\\n      \\\"toDate\\\": \\\"2017-04-16\\\",\\n      \\\"chargeType\\\": \\\"INITIAL\\\"\\n    }\\n  }\\n}\",\n      \"language\": \"json\",\n      \"name\": \"200 OK - Apple Pay\"\n    },\n    {\n      \"code\": \"{\\n  \\\"planId\\\": 2436197,\\n  \\\"vaultedShopperId\\\": 21804015,\\n  \\\"softDescriptor\\\": \\\"Oooops LTD\\\",\\n  \\\"payerInfo\\\": {\\n    \\\"firstName\\\": \\\"John\\\",\\n    \\\"lastName\\\": \\\"Doe\\\",\\n    \\\"country\\\": \\\"fr\\\",\\n    \\\"zip\\\": \\\"12345\\\",\\n    \\\"phone\\\": \\\"1234567890\\\"\\n  },\\n  \\\"paymentSource\\\": {\\n    \\\"sepaDirectDebitInfo\\\": {\\n      \\\"sepaDirectDebit\\\": {\\n        \\\"ibanFirstFour\\\": \\\"DE09\\\",\\n        \\\"ibanLastFour\\\": \\\"7893\\\",\\n        \\\"mandateId\\\": \\\"Ooo154091\\\",\\n        \\\"mandateDate\\\": \\\"25-Jul-17\\\",\\n        \\\"preNotificationText\\\": \\\"The amount of 29.99 EUR will be collected using SEPA Direct Debit with Mandate Ooo154091 from your bank account IBAN DE09XXXXXX7893 in the next few days. Please ensure sufficient funds in your account.\\\"\\n      }\\n    }\\n  },\\n  \\\"charge\\\": {\\n    \\\"planId\\\": 2436197,\\n    \\\"vaultedShopperId\\\": 21804015,\\n    \\\"transactionId\\\": \\\"1011216623\\\",\\n    \\\"transactionDate\\\": \\\"2017-07-25\\\",\\n    \\\"amount\\\": 29.99,\\n    \\\"currency\\\": \\\"EUR\\\",\\n    \\\"softDescriptor\\\": \\\"Oooops LTD\\\",\\n    \\\"paymentSource\\\": {\\n      \\\"sepaDirectDebitInfo\\\": {\\n        \\\"sepaDirectDebit\\\": {\\n          \\\"ibanFirstFour\\\": \\\"DE09\\\",\\n          \\\"ibanLastFour\\\": \\\"7893\\\",\\n          \\\"mandateId\\\": \\\"Ooo154091\\\",\\n          \\\"mandateDate\\\": \\\"25-Jul-17\\\",\\n          \\\"preNotificationText\\\": \\\"The amount of 29.99 EUR will be collected using SEPA Direct Debit with Mandate Ooo154091 from your bank account IBAN DE09XXXXXX7893 in the next few days. Please ensure sufficient funds in your account.\\\"\\n        }\\n      }\\n    },\\n    \\\"processingInfo\\\": {\\n      \\\"processingStatus\\\": \\\"PENDING\\\"\\n    }\\n  }\\n}\",\n      \"language\": \"json\",\n      \"name\": \"200 OK - SEPA Direct Debit \"\n    },\n    {\n      \"code\": \"{\\n  \\\"planId\\\": 2380391,\\n  \\\"vaultedShopperId\\\": 22330617,\\n  \\\"softDescriptor\\\": \\\"default_descriptor\\\",\\n  \\\"payerInfo\\\": {\\n    \\\"firstName\\\": \\\"Jane\\\",\\n    \\\"lastName\\\": \\\"Doe\\\",\\n    \\\"country\\\": \\\"us\\\",\\n    \\\"zip\\\": \\\"12345\\\",\\n    \\\"phone\\\": \\\"1234567890\\\"\\n  },\\n  \\\"paymentSource\\\": {\\n    \\\"ecpInfo\\\": {\\n      \\\"ecp\\\": {\\n        \\\"accountNumber\\\": \\\"4099999992\\\",\\n        \\\"routingNumber\\\": \\\"011075150\\\",\\n        \\\"accountType\\\": \\\"CONSUMER_CHECKING\\\"\\n      }\\n    }\\n  },\\n  \\\"charge\\\": {\\n    \\\"planId\\\": 2380391,\\n    \\\"vaultedShopperId\\\": 22330617,\\n    \\\"transactionId\\\": \\\"1015610101\\\",\\n    \\\"transactionDate\\\": \\\"2018-01-25\\\",\\n    \\\"amount\\\": 65,\\n    \\\"currency\\\": \\\"USD\\\",\\n    \\\"softDescriptor\\\": \\\"default_descriptor\\\",\\n    \\\"paymentSource\\\": {\\n      \\\"ecpInfo\\\": {\\n        \\\"ecp\\\": {\\n          \\\"accountNumber\\\": \\\"4099999992\\\",\\n          \\\"routingNumber\\\": \\\"011075150\\\",\\n          \\\"accountType\\\": \\\"CONSUMER_CHECKING\\\"\\n        }\\n      }\\n    },\\n    \\\"chargeInfo\\\": {\\n      \\\"chargeType\\\": \\\"INITIAL\\\"\\n    },\\n    \\\"processingInfo\\\": {\\n      \\\"processingStatus\\\": \\\"PENDING\\\"\\n    }\\n  }\\n}\",\n      \"language\": \"json\",\n      \"name\": \"200 OK - ACH/ECP\"\n    },\n    {\n      \"code\": \"{\\n    \\\"subscriptionId\\\": 39594120,\\n    \\\"planId\\\": 2203980,\\n    \\\"vaultedShopperId\\\": 19637272,\\n    \\\"status\\\": \\\"ACTIVE\\\",\\n    \\\"quantity\\\": 1,\\n    \\\"softDescriptor\\\": \\\"BLS\\\",\\n    \\\"chargeFrequency\\\": \\\"MONTHLY\\\",\\n    \\\"recurringChargeAmount\\\": 1.99,\\n    \\\"currency\\\": \\\"USD\\\",\\n    \\\"autoRenew\\\": true,\\n    \\\"nextChargeDate\\\": \\\"2018-10-05\\\",\\n    \\\"payerInfo\\\": {\\n        \\\"firstName\\\": \\\"test first name\\\",\\n        \\\"lastName\\\": \\\"test last name\\\", \\n      \\t\\\"zip\\\": \\\"12345\\\",\\n        \\\"country\\\": \\\"us\\\",\\n        \\\"state\\\": \\\"MA\\\",\\n        \\\"email\\\": \\\"test&#x40;gmail.com\\\",\\n        \\\"address\\\": \\\"32 some street\\\",\\n        \\\"city\\\": \\\"some city\\\",\\n        \\\"zip\\\": \\\"02186\\\",\\n        \\\"phone\\\": \\\"456276576\\\"\\n    },\\n    \\\"paymentSource\\\": {\\n        \\\"creditCardInfo\\\": {\\n            \\\"billingContactInfo\\\": {\\n                \\\"firstName\\\": \\\"test first name\\\",\\n                \\\"lastName\\\": \\\"test last name\\\", \\n      \\t        \\\"zip\\\": \\\"123456\\\",\\n                \\\"country\\\": \\\"us\\\",\\n                \\\"state\\\": \\\"MA\\\",\\n                \\\"address\\\": \\\"32 some street\\\",\\n                \\\"city\\\": \\\"some city\\\",\\n                \\\"zip\\\": \\\"02186\\\"\\n            },\\n            \\\"creditCard\\\": {\\n                \\\"cardLastFourDigits\\\": \\\"1111\\\",\\n                \\\"cardType\\\": \\\"VISA\\\",\\n                \\\"cardSubType\\\": \\\"CREDIT\\\",\\n                \\\"cardCategory\\\": \\\"CLASSIC\\\",\\n                \\\"expirationMonth\\\": \\\"09\\\",\\n                \\\"expirationYear\\\": \\\"2022\\\"\\n            }\\n        }\\n    },\\n    \\\"charge\\\": {\\n        \\\"chargeId\\\": 250389,\\n        \\\"subscriptionId\\\": 39594120,\\n        \\\"planId\\\": 2203980,\\n        \\\"vaultedShopperId\\\": 19637272,\\n        \\\"transactionId\\\": \\\"38589782\\\",\\n        \\\"transactionDate\\\": \\\"2018-09-05\\\",\\n        \\\"amount\\\": 1.99,\\n        \\\"currency\\\": \\\"USD\\\",\\n        \\\"softDescriptor\\\": \\\"BLS\\\",\\n        \\\"paymentSource\\\": {\\n            \\\"creditCardInfo\\\": {\\n                \\\"creditCard\\\": {\\n                    \\\"cardLastFourDigits\\\": \\\"1111\\\",\\n                    \\\"cardType\\\": \\\"VISA\\\",\\n                    \\\"cardSubType\\\": \\\"CREDIT\\\",\\n                    \\\"cardCategory\\\": \\\"CLASSIC\\\",\\n                    \\\"expirationMonth\\\": \\\"09\\\",\\n                    \\\"expirationYear\\\": \\\"2022\\\"\\n                }\\n            }\\n        },\\n        \\\"chargeInfo\\\": {\\n            \\\"fromDate\\\": \\\"2018-09-05\\\",\\n            \\\"toDate\\\": \\\"2018-10-05\\\",\\n            \\\"chargeType\\\": \\\"INITIAL\\\"\\n        },\\n        \\\"processingInfo\\\": {\\n            \\\"processingStatus\\\": \\\"SUCCESS\\\"\\n        }\\n    },\\n    \\\"fraudResultInfo\\\": {\\n        \\\"deviceDataCollector\\\": \\\"N\\\"\\n    }\\n}\",\n      \"language\": \"json\",\n      \"name\": \"200 OK - Google Pay\"\n    },\n    {\n      \"code\": \"{\\n    \\\"cardTransactionType\\\": \\\"AUTH_ONLY\\\",\\n    \\\"transactionId\\\": \\\"1012751937\\\",\\n    \\\"recurringTransaction\\\": \\\"ECOMMERCE\\\",\\n    \\\"softDescriptor\\\": \\\"BLS&#x2a;DescTest\\\",\\n    \\\"amount\\\": 11,\\n    \\\"currency\\\": \\\"USD\\\",\\n    \\\"cardHolderInfo\\\": {\\n        \\\"firstName\\\": \\\"test first name\\\",\\n        \\\"lastName\\\": \\\"test last name\\\", \\n      \\t\\\"zip\\\": \\\"123456\\\",\\n        \\\"country\\\": \\\"us\\\"\\n    },\\n    \\\"vaultedShopperId\\\": 21289371,\\n    \\\"wallet\\\": {\\n        \\\"walletType\\\": \\\"GOOGLE_PAY\\\",\\n        \\\"billingContactInfo\\\": {\\n            \\\"firstName\\\": \\\"test first name\\\",\\n            \\\"lastName\\\": \\\"test last name\\\",\\n            \\\"zip\\\": \\\"12345\\\",\\n            \\\"country\\\": \\\"us\\\"\\n        },\\n        \\\"tokenizedCard\\\": {\\n            \\\"cardLastFourDigits\\\": \\\"1111\\\",\\n            \\\"cardType\\\": \\\"VISA\\\",\\n            \\\"cardSubType\\\": \\\"CREDIT\\\",\\n            \\\"dpanExpirationMonth\\\": \\\"9\\\",\\n            \\\"dpanExpirationYear\\\": \\\"2025\\\",\\n            \\\"dpanLastFourDigits\\\": \\\"2222\\\"\\n        }\\n    },\\n    \\\"processingInfo\\\": {\\n        \\\"processingStatus\\\": \\\"success\\\"\\n    }\\n}\",\n      \"language\": \"json\",\n      \"name\": \"200 OK - Google Pay with tokenized card\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n<a class=\"btn btn-primary\" href=\"#\" role=\"button\">Back to Top</a>\n\n<hr>\n\n##Example Descriptions\n\n###Create Subscription: with new shopper\nThis example shows a basic Create Subscription request for a new shopper, with details about the shopper and their payment method. If you are using client-side encryption, you can send the encrypted card info in this requested instead of the plain card details.\n\n###Create Subscription: with vaulted shopper and optional fields\nThis example shows a Create Subscription request with an existing vaulted shopper who has only one saved payment method, so there is no need to specify which payment method to use.\n\nThis example request also includes all optional subscription fields, such as quantity, soft descriptor and the various override fields. The override values take precedence over the settings at the plan level, and they apply only to this subscription. \n\n###Create Subscription: with vaulted shopper and specific payment method\nThis example shows a Create Subscription request with an existing vaulted shopper who has multiple saved payment methods, so you must specify which payment method to use.\n\n### Create Subscription: with new shopper and Hosted Payment Fields\nThis example shows a Create Subscription request with a new shopper whose card information was collected using [Hosted Payment Fields](/v8976-Tools/docs/hosted-payment-fields). Include `pfToken` in the request with its value set to the Hosted Payment Fields token. \n\n### Create Subscription: with new shopper and vendor info\nThis example shows a Create Subscription request with a new shopper and a [Marketplace](/docs/marketplace-overview) vendor. To link the vendor to the transaction, include `vendorId` within `vendorInfo` in the request.\n\n###Create Subscription: with Apple Pay\nThis example shows a Create Subscription request with an Apple Pay wallet. In the request, include `encodedPaymentToken` inside `paymentSource` > `wallet` > `applePay`. See the [Apple Pay Guide](/docs/apple-pay#section-implementing-apple-pay-in-your-website-or-ios-app) for more information.\n\n**Note**: To test Apple Pay, follow the steps in the [Apple Pay Guide](/docs/apple-pay#section-implementing-apple-pay-in-your-website-or-ios-app). The API Explorer does not support Apple Pay testing. \n\n###Create Subscription: with SEPA Direct Debit\nThis example shows a Create Subscription request with a new shopper with the SEPA Direct Debit payment method. In the request, include `authorizedByShopper` with a value set to **true** to indicate that you've collected the shopper's [mandate acceptance](/docs/sepa-direct-debit#section-step-1-collect-a-mandate-acceptance-from-your-shopper). Include the shopper's bank account details within `paymentSource` > `sepaDirectDebitInfo` > `sepaDirectDebit`. \n\n**Note:** `subscriptionId` will not be returned in the response. The subscription ID will be created when the shopper's account is debited (typically within 5 - 6 business days). You will then be informed of the subscription ID via `Charge` webhook or via [Retrieve Specific Charge](doc:retrieve-specific-charge) request. \n\n###Create Subscription: with ACH/ECP\nThis example shows a Create Subscription request with a new shopper with the ACH/ECP payment method. In the request, include `authorizedByShopper` with a value set to **true** to indicate that you've collected the shopper's permission to debit their account. Include the shopper's bank account details within `paymentSource` > `ecpInfo` > `ecp`. If you would like to process the transaction for a returning shopper, pass an empty `ecpInfo` object. \n\n**Note:** `subscriptionId` will not be returned in the response. The subscription ID will be created when the shopper's account is debited (typically within 2 business days). You will then be informed of the subscription ID via `Charge` webhook or via [Retrieve Specific Charge](doc:retrieve-specific-charge) request. \n\n###Create Subscription: with Google Pay™\nThis example shows a Create Subscription request with a Google Pay wallet. In the request, include  `walletType` = GOOGLE_PAY and `encodedPaymentToken` inside `paymentSource` > `wallet`. See the [Google Pay Guide](/docs/google-pay) for more information.\n\n<br>\n\n<a class=\"btn btn-primary\" href=\"#\" role=\"button\">Back to Top</a>\n\n<hr>\n\n##API Explorer\nTo test out a call, enter the request content below and then click **Try it!**\n\n**Tip**: Use the JSON code below as a starting point. You can enter different parameters to see how your test scenario would work. *The request headers, including authorization, are already built in for you in this test area, so you should not include them here.*\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"payerInfo\\\": {\\n        \\\"zip\\\": 12345,\\n        \\\"firstName\\\": \\\"John\\\",\\n        \\\"lastName\\\": \\\"Doe\\\",\\n        \\\"phone\\\": 1234567890\\n    },\\n    \\\"paymentSource\\\": {\\\"creditCardInfo\\\": {\\\"creditCard\\\": {\\n        \\\"expirationYear\\\": 2019,\\n        \\\"securityCode\\\": 111,\\n        \\\"expirationMonth\\\": \\\"07\\\",\\n        \\\"cardNumber\\\": 4111111111111111\\n    }}},\\n    \\\"planId\\\": 2283845\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"create-subscription","type":"endpoint","title":"Create Subscription"}