3min

Subscription

When requesting a Subscription, use the requestJSON to pass the Subscription data, and the response will have responseJSON which stores the Subscription response returned by Breadwinner Payments.

The Subscription object has the following properties.
SubscriptionField Name
Data Type
Description
processorCustomerId*﻿
String
Customer Id in the Processor ﻿(Find this) 
collectionMethod*﻿
String
Either 'send_invoice' or 'charge_automatically'
daysUntilDue
Integer
Conditionally required. Passed if collectionMethod is send_invoice, by default it will be 14 days.
processorPaymentMethodId
String
Passed if collectionMethod is charge_automatically.
If not set, invoices will use the customer’s default_source.
﻿﻿(Find this) 
trialPeriodDays
Integer
Free trail days
startDate
DateTime
Used in case of Subscription Schedule creation. It indicates when the subscription schedule starts.
coupon
String
Coupon Id in the Processor
items*﻿
List ﻿(items) 
At least one line item is required to create a Subscription.
cancelAtPeriodEnd
Boolean
Indicates whether the subscription should cancel at the end of the current period.
cancelAt
DateTime
A timestamp at which the subscription should cancel.
description
String
The subscription’s description, meant to be displayable to the customer.
trialEnd
DateTime
The end of the trial period the customer will get before being charged for the first time.
trialFromPlan
Boolean
Indicates if a plan’s trial period days should be applied to the subscription. Setting trialEnd per subscription is preferred, and this defaults to false.
Setting this flag to true together with trialEnd is not allowed.
backDateStartDate
DateTime
A past timestamp to backdate the subscription’s start date to.
billingCycleAnchor
DateTime
A future timestamp to anchor the subscription’s billing cycle.
promotionCode
String
The API ID of a promotion code to apply to this subscription
prorationBehavior
String
Determines how to handle prorations resulting from the billingCycleAnchor. The default is create_prorations.
salesforceCustomerId
String
readOnly field
salesforceId
String
readOnly field
currentPeriodStartDate
DateTime
readOnly field
currentPeriodEndDate
DateTime
readOnly field
latestInvoice
String
readOnly field
createdDateInProcessor
DateTime
readOnly field
processorOrgId
String
readOnly field
salesforceAccount
String
readOnly field
salesforceContact
String
readOnly field
procesorSubscriptionId
String
readOnly field
status
String
readOnly field
ItemsField Name
Data Type
Description
processorPriceId
String
Id of the specific Product/Price that is getting added to the Subscription. Note: this is the Id in the Processor not in Salesforce.
quantity
Integer
﻿
name
String
readOnly field
amount
Decimal
readOnly field
chargeCurrency
String
readOnly field
description
String
readOnly field
invoice
String
readOnly field
salesforcePriceId
String
readOnly field
salesforceId
String
readOnly field
salesforceSubscriptionId
String
readOnly field
procesorSubscriptionId
String
readOnly field
processorId
String
readOnly field
unitAmount
Decimal
readOnly field
unitAmountDecimal
Decimal
readOnly field
﻿

Updated 22 Feb 2023

Did this page help you?

Yes

UP NEXT

Create Subscription

Docs powered by archbee

TABLE OF CONTENTS

Subscription

Items

Field Name	Data Type	Description
processorCustomerId*	String	Customer Id in the Processor (Find this)
collectionMethod*	String	Either 'send_invoice' or 'charge_automatically'
daysUntilDue	Integer	Conditionally required. Passed if collectionMethod is send_invoice, by default it will be 14 days.
processorPaymentMethodId	String	Passed if collectionMethod is charge_automatically. If not set, invoices will use the customer’s default_source. (Find this)
trialPeriodDays	Integer	Free trail days
startDate	DateTime	Used in case of Subscription Schedule creation. It indicates when the subscription schedule starts.
coupon	String	Coupon Id in the Processor
items*	List (items)	At least one line item is required to create a Subscription.
cancelAtPeriodEnd	Boolean	Indicates whether the subscription should cancel at the end of the current period.
cancelAt	DateTime	A timestamp at which the subscription should cancel.
description	String	The subscription’s description, meant to be displayable to the customer.
trialEnd	DateTime	The end of the trial period the customer will get before being charged for the first time.
trialFromPlan	Boolean	Indicates if a plan’s trial period days should be applied to the subscription. Setting trialEnd per subscription is preferred, and this defaults to false. Setting this flag to true together with trialEnd is not allowed.
backDateStartDate	DateTime	A past timestamp to backdate the subscription’s start date to.
billingCycleAnchor	DateTime	A future timestamp to anchor the subscription’s billing cycle.
promotionCode	String	The API ID of a promotion code to apply to this subscription
prorationBehavior	String	Determines how to handle prorations resulting from the billingCycleAnchor. The default is create_prorations.
salesforceCustomerId	String	readOnly field
salesforceId	String	readOnly field
currentPeriodStartDate	DateTime	readOnly field
currentPeriodEndDate	DateTime	readOnly field
latestInvoice	String	readOnly field
createdDateInProcessor	DateTime	readOnly field
processorOrgId	String	readOnly field
salesforceAccount	String	readOnly field
salesforceContact	String	readOnly field
procesorSubscriptionId	String	readOnly field
status	String	readOnly field