Subscription - Square
To create a Subscription in Square, the following properties can be provided. Those marked with * are required.
To activate the Subscription and immediately charge the Customer, provide a Payment method ID and set the value of startDate to today or null, otherwise, the Square processor bills an invoice to the customer's email address. The subscription is scheduled if the startDate value in the request object is in the future.
Field Name | Data Type | Description |
|---|---|---|
action* | String | value must be "CreateSubscription" |
processorCustomerId* | String | Customer Id in the Processor (Find this) |
processorId* | String | Id of the Sqaure processor |
processorPlanId* | String | Id of the specific Product (Plan) that is getting added to the Subscription. Note: this is the Id in the Processor, not in Salesforce. |
collectionMethod | String | readOnly field |
createdDateInProcessor | DateTime | readOnly field |
currentPeriodEndDate | DateTime | readOnly field |
currentPeriodStartDate | DateTime | readOnly field |
errorMessage | String | readOnly field |
latestInvoice | String | readOnly field |
locationId | String | The locationId of the org where the customer is associated with. If the location Id is null, the API sets the main location ID by default |
processorPaymentMethodId | String | Card/Account Id of the customer to be charged |
procesorSubscriptionId | String | readOnly field |
salesforceAccount | String | readOnly field |
salesforceContact | String | readOnly field |
salesforceCustomerId | String | readOnly field |
salesforceId | String | readOnly field |
startDate | Date | Subscription activation date |
status | String | readOnly field |
