customerId | Integer | This is the Id of the Customer to whom this Subscription has been applied. |
planFrequency | Object (definition below) | This provides details of the plan frequency that was used to configure the subscription. |
planCode | String | This is the unique code which represents the Plan of which this Subscription is an instance. |
planName | String | This is the name of the plan of which this Subscription is an instance. |
planDescription | String | This is the description text of the Plan of which this Subscription is an instance of. |
planReference | String | This is a text field which will be populated with the reference text from the plan. This field is not exposed on the Invoice. |
status | Enum: {Active, Draft, Cancelled, Provisioning, Expired, Migrated, Suspended, StandingOrder} | This is the status of this subscription. Draft indicates that the Subscription has not yet been activated. Provisioning indicates this Subscription has been provisioned but that the Setup Fee and recurring Charge has not been applied to the Customer. To set a Subscription as "Provisioned" you must set a Scheduled Activation Date for some time in the future. |
reference | String | This is a text field you can populate with reference text for this subscription. This field is shown on invoices. |
subscriptionOverride | Object. Defined below | This represents a subscription-level override made after the object's creation. |
hasPostedInvoice | Boolean | This indicates if this Subscription has caused an invoice to be created and posted against the Customer's account. |
CreatedTimestamp | DateTime | This indicates when the Subscription was created. |
ActivatedTimestamp | DateTime | This indicates when the Subscription was activated. |
ProvisionedTimestamp | DateTime | This indicates when the Subscription was provisioned. |
NextPeriodStartDate | DateTime | This indicates when the next billing period for the Subscription will begin. Normally, this indicates when the subscription will bill and apply charges to the customer's account. |
lastPeriodStartDate | DateTime | This is the timestamp of when the previous period started for this subscription if there was a previous period. |
ScheduledActivationTimestamp | DateTime | If set, this indicates when the Subscription should activate. The subscription will automatically be set to an "Active" status at this time if it has been set to status "Provisioned". |
subscriptionProducts | List of Objects. See the Subscription Products Object section for the definition. | The list of subscription products on the purchase, both included and excluded. |
remainingInterval | Integer | This is the remaining number of billing intervals in the lifetime of this subscription. If this value is set to null the subscription will renew indefinitely. If this is set to a number then after that number of intervals have passed the subscription will go to the "Expired" status automatically and stop charging the customer. |
remainingIntervalPushOut | Integer | This is the setting to default what the new remaining interval should be when the subscription is renewed. |
openSubscriptionPeriodEndDate | DateTime | This is the date that the current billing period will end. Often, this field will match the nextPeriodStartDate value. |
customFields | List of Objects. See Catalog: Custom Fields for object definition. | Custom fields hold additional data. This data is associated with the subscription. |
planAutoApplyChanges | Boolean | This field related to Grandfathering control. If true, this indicates that the Plan from which this Subscription is made usually pushes changes to the Plan down to existing Subscriptions - this forces existing customers onto the newest version of the Plan. If set to False, this 'grandfathers' the Customer into the version of the Plan they Subscribed to and does not push changes. |
autoApplyCatalogChanges | Boolean | This field controls if this specific Subscription should automatically push changes to the underlying Plan to this Subscription. If set to True, changes will be pushed automatically. If False, this Subscription will not reflect updates to the Plan from which it was made. |
monthlyRecurringRevenue | Decimal | The calculated monthly recurring revenue value being generated by this subscription. |
netMonthlyRecurringRevenue | Decimal | The net MRR being generated by this subscription. |
amount | Decimal | The amount of the subscription. |
contractStartTimestamp | DateTime | This is the date that the contract period will begin. |
contractEndTimestamp | DateTime | This is the date that the contract period will end. |
expiredTimestamp | DateTime | The timestamp of when this subscription expired if it is in status "Expired". |
cancellationTimestamp | DateTime | The timestamp of when this subscription became cancelled if it is in status "Cancelled". |
modifiedTimestamp | DateTime | The timestamp of the last modification to this entity. |
coupons | List of Objects. See Subscriptions: Coupons Object for details. | The list of coupons that have been applied to this subscription |
invoiceDay | Integer | The day of the month recharge occurs for this subscription. |
invoiceMonth | Integer | Tells the system to create a billing period that cycles on the specified month. Typically only used for yearly frequencies. If this parameter is used for a monthly frequency, Fusebill will adjust the billing period such that the subscription will recharge on the provided day and month. |
canMigrate | Boolean | True as long as their is at least one plan family relationship with this subscription's plan code as the source. |
migrationDate | DateTime | The timestamp when this subscription entered status "Migrated". |
scheduledMigrationDate | DateTime | The timestamp of when the scheduled migration for this subscription will occur if a migration has been scheduled. |
migrations | Object. Defined below. | A summary of the migration which resulted in this subscription, and the migration which was sourced from this subscription. Possibly null if the subscription is not associated to any migrations. |
subscriptionHasRecurringEndOfPeriodCharge | Boolean | True if the subscription has a recurring end of period charge |
nextRechargeDate | DateTime | The timestamp for when this subscription will recharge next. |
billingPeriodDefinitionId | Integer | The Fusebill generated ID that uniquely identifies the associated billing period definition. |
salesforceId | String | The Salesforce ID of the subscription in Salesforce that this object maps to. This is for the Salesforce plugin. |
id | Integer | The Fusebill generated ID that uniquely identifies this subscription. |
invoiceOwner | Enum: {InvoiceParent, InvoiceThisCustomer} | Indicates charges will appear on customer invoice or on parent's invoice. |
geotabDeviceCodes | Array of Strings | The set of device product codes associated with this standing order subscription. Used to differentiate between multiple first-party devices on the same device plan. Matching is case-insensitive, ignores hyphens, and uses longest-prefix-first logic. |
invoiceOwnerId | Integer | The Invoice Owner ID of the subscription object in Stax Bill. |
uri | String | The full string path to this resource. |
