> ## Documentation Index
> Fetch the complete documentation index at: https://docs.slm.m1amdocs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Billing Plan

Billing Plan is available to Subscribe (Basic) and Subscribe (Premium) application users.

Billing Plan includes the following SFDC parent objects:

* Billing\_Plan\_\_C
* Billing\_Plan\_Entitlement\_c
* Billing\_Plan\_Period\_c
* Billing\_Plan\_Period\_Price\_c

## Billing\_Plan\_\_C

| SFDC Field Name | SFDC API Name | Subscribe Object | Subscribe Field | Description |
| - | - | - | - | - |
| Active | cashbox\_Active\_c | N/A | N/A | A true/false flag indicating whether this Billing Plan is set to Active in Subscribe |
| # of Indefinite Periods | cashbox\_Num\_of\_Indefinite\_Periods\_c | N/A | N/A | A count of the number of indefinitely recurring Billing Periods defined for this Plan. Any number above 0 will indicate that the plan is an indefinitely auto-renewing subscription. |
| Billing Plan Currencies | cashbox\_Billing\_Plan\_Currencies\_c | BillingPlanPrice | currency\_x | A concatenated list of currency related to this Billing Plan period prices |
| Billing Plan ID | cashbox\_Billing\_Plan\_ID\_c | BillingPlan | merchantBillingPlanId | The merchant-specified Billing Plan Identifier from Subscribe. As this is an optional field in Subscribe, the application does not treat it like a unique key within the Salesforce account, but it is provided so that it can be used as such if it fits your business. |
| Billing Statement Identifier | cashbox\_Billing\_Statement\_Identifier\_c | BillingPlan | billingStatementIdentifier | The Billing Statement Identifier string associated with this Billing Plan for use in template communications and downstream Payment Processors. |
| Description | cashbox\_Description\_c | BillingPlan | description | The Description provided for this Billing Plan as defined in Subscribe |
| End of Life | cashbox\_End\_of\_Life\_c | BillingPlan | endOfLifeTimestamp | The Plan's scheduled "End of Life" as defined in Subscribe |
| Indefinite | cashbox\_Indefinite\_c | N/A | N/A | A true/false flag indicating whether this Billing Plan has one or more "indefinite" periods (and is therefore an infinitely recurring plan). |
| Plan Duration | cashbox\_Plan\_Duration\_c | N/A | N/A | The total duration of this Plan in days. If the plan is "Indefinite" this value will be 0. |
| Pre-notify # of Days | cashbox\_Pre\_notify\_of\_Days\_c | BillingPlan | prenotifyDays | The plan length: The # of days configured for Pre-notification as defined in Subscribe |
| Product Manager | cashbox\_Product\_Manager\_c | N/A | N/A | NOT USED - This fields purpose has been replaced by the use of Merchant Data (custom name-value pairs) |
| Vindicia Record ID | cashbox\_VID\_c | BillingPlan | VID | The global identifier assigned to the Billing Plan by Subscribe. Used for reference. |

## Billing\_Plan\_Entitlement\_c

| SFDC Field Name | SFDC API Name | SFDC Field Name | Subscribe Field | Description |
| - | - | - | - | - |
| Active | cashbox\_Active\_c | N/A | N/A | Indicator for whether or not the Entitlement is currently Active for this Account |
| Billing Plan | cashbox\_Billing\_Plan\_c | N/A | N/A | The specific Billing Plan Identifier granting this Entitlement. |
| Description | cashbox\_Description\_c | MerchantEntitlementId | description | The "Description" of the Entitlement as defined within Subscribe |

## Billing\_Plan\_Period\_c

| SFDC Field Name | SFDC API Name | Subscribe Object | Subscribe Field | Description |
| - | - | - | - | - |
| # of Cycles | cashbox\_Num\_of\_Cycles\_c | BillingPlanPeriod | cycles | The # of Cycles which will occur for this Period |
| Active | cashbox\_Active\_c | N/A | N/A | A true/false flag indicating whether this Billing Plan is set to Active in Subscribe |
| Billing Plan | cashbox\_Billing\_Plan\_c | N/A | N/A | The specific Billing Plan Identifier to which this Period belongs. |
| Cycle Duration | cashbox\_Cycle\_Duration\_c | BillingPlanPeriod | quantity | The specified duration value (a number) for which the Period occurs. |
| Cycle Duration | cashbox\_Cycle\_Duration\_formula\_c | N/A | N/A | This field is a version of the "Cycle Duration" used for calculating various formulas in the application. |
| Cycle Period | cashbox\_Cycle\_Period\_c | BillingPlanPeriod | type\_x | The time measure (Day, Month, etc.) for the Period. |
| Do Not Notify Before First Bill | cashbox\_Do\_Not\_Notify\_Before\_First\_Bill\_c | BillingPlanPeriod | doNotNotifyFirstBill | The "Do Not Notify Before First Bill" Setting as defined in Subscribe |
| Duration (calc) | cashbox\_Duration\_c | N/A | N/A | A field used for calculating various formulas in the application. |
| Expire Warning # of Days | cashbox\_Expire\_Warning\_of\_Days\_c | BillingPlanPeriod | expireWarningDays | The "Expire Warning # of Days" Setting as defined in Subscribe |
| Free | cashbox\_Free\_c | BillingPlanPeriod | free | A true/false flag indicating whether this Billing Plan Period is designates as FREE. |
| Sort Order | cashbox\_Sort\_Order\_c | N/A | N/A | The sequence defining the order in which Billing Periods occur. |

## Billing\_Plan\_Period\_Price\_c

| SFDC Field Name | SFDC API Name | Subscribe Object | Subscribe Field | Description |
| - | - | - | - | - |
| Currency/Token | cashbox\_Currency\_Token\_c | BillingPlanPrice | currency\_x | The Currency Code or Token ID associated with this specific Price. |
| cashbox\_Price\_List\_Name\_c | BillingPlanPrice | priceListName | NOT USED - This fields purpose has been replaced by the use of Merchant Data (custom name-value pairs) | cashbox\_Price\_List\_Name\_c |
| cashbox\_Price\_Type\_c | N/A | N/A | NOT USED - This fields purpose has been replaced by the use of Merchant Data (custom name-value pairs) | cashbox\_Price\_Type\_c |
| **Parent topic:**[Data Mapping: Subscribe (Basic) and (Premium)](../topics/tp_dataMappingBasic) | | | | |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.