A migration object represents a scheduled change from a subscription based on one plan to a subscription based on another plan. The rules and relationships between plans are defined in a plan family at the catalog level. See Catalog: Plan Family Object for more details
Migration Object Fields
| Property | Type | Description |
|---|---|---|
customerId | Integer | The ID of the customer who owns the subscription |
planFamilyId | Integer | The ID of the plan family which contains the plan family relationship being used |
planFamilyRelationshipId | Integer | The ID of the plan family relationship which defines the rules for how to change from this subscription to the new subsctiption |
planFrequencyId | Integer | The plan frequency ID of the current subscription. |
earningOption | Enum: {FamilyDefault, None, Unearned, Full} | Controls how to handle the financials of the source subscription. Charges can be fully earned, the unearned charges can be reversed, or all the charges can be reversed. |
nameOverrideOption | Enum: {FamilyDefault, DoNotTransfer, Transfer} | Controls whether the name is transferred from the source subscription to the destination |
descriptionOverrideOption | Enum: {FamilyDefault, DoNotTransfer, Transfer} | Controls whether the description is transferred from the source subscription to the destination |
referenceOption | Enum: {FamilyDefault, DoNotTransfer, Transfer} | Controls whether the subscription reference is transferred from the source subscription to the destination |
expiryOption | Enum: {FamilyDefault, DoNotTransfer, Transfer} | Controls whether the expiry progression is transferred from the source subscription to the destination |
customFieldsOption | Enum: {FamilyDefault, DoNotTransfer, Transfer} | Controls whether the custom fields are transferred from the source subscription to the destination |
contractStartOption | Enum: {FamilyDefault, DoNotTransfer, Transfer} | Controls whether the name is transferred from the source subscription to the destination |
contractEndOption | Enum: {FamilyDefault, DoNotTransfer, Transfer} | Controls whether the name is transferred from the source subscription to the destination |
planFamilyRelationship | Object. See Catalog: Plan Family Object for details | Each plan family relationship defines special rules for going from a source plan subscription to a destination plan subscription. A plan family relationship between two plans in a family must exist for a migration to occur along the defined path. |
planFamily | Object. See Catalog: Plan Family Object for details | plan family relationships belong to a plan family |
migrationTimingOption | Enum: {NextBillingPeriod, SpecificDate} | An option dictating how to schedule the migration |
scheduledMigrationDate | Timestamp | If migrationTimingOption is "NextBillingPeriod", then this is null. Otherwise, this is the timestamp of when the change is to occur. |
id | Integer | The Fusebill generated ID of the subscription that is to become migrated (the source description) |
uri | String | The full string path to this resource |