Create a subscription preview

post

/crmRestApi/resources/11.13.18.05/previewSubscriptions

Request

Header Parameters
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Nested Schema : Preview Subscription Products
Type: array
Title: Preview Subscription Products
Preview subscriptions lets you view a subscription product before creating, updating, or deleting a subscription.
Show Source
Nested Schema : previewSubscriptions-products-item-post-request
Type: object
Show Source
Nested Schema : Amended Product
Type: array
Title: Amended Product
Preview subscriptions lets you view amended subscription product details before creating, updating or deleting a subscription.
Show Source
Nested Schema : Preview Subscription Charges
Type: array
Title: Preview Subscription Charges
Preview subscriptions lets you view amended subscription product charges before creating, updating, or deleting a subscription.
Show Source
Nested Schema : Preview Subscription Bill Lines
Type: array
Title: Preview Subscription Bill Lines
Preview subscriptions lets you view subscription product details before creating, updating, or deleting a subscription.
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : Preview Subscription Charges
Type: array
Title: Preview Subscription Charges
Preview subscriptions lets you view amended subscription product charges before creating, updating, or deleting a subscription.
Show Source
Nested Schema : Preview Subscription Bill Lines
Type: array
Title: Preview Subscription Bill Lines
Preview subscriptions lets you view subscription product details before creating, updating, or deleting a subscription.
Show Source
Nested Schema : previewSubscriptions-products-amendedProduct-charges-item-post-request
Type: object
Show Source
Nested Schema : Subscription Charge Adjustment
Type: array
Title: Subscription Charge Adjustment
Show Source
Nested Schema : previewSubscriptions-products-amendedProduct-charges-adjustments-item-post-request
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : Subscription Charge Adjustment
Type: array
Title: Subscription Charge Adjustment
Show Source
Nested Schema : previewSubscriptions-products-charges-adjustments-item-post-request
Type: object
Show Source
Nested Schema : previewSubscriptions-products-output-item-post-request
Type: object
Show Source
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : previewSubscriptions-item-response
Type: object
Show Source
Nested Schema : Preview Subscription Products
Type: array
Title: Preview Subscription Products
Preview subscriptions lets you view a subscription product before creating, updating, or deleting a subscription.
Show Source
Nested Schema : previewSubscriptions-products-item-response
Type: object
Show Source
Nested Schema : Amended Product
Type: array
Title: Amended Product
Preview subscriptions lets you view amended subscription product details before creating, updating or deleting a subscription.
Show Source
Nested Schema : Preview Subscription Charges
Type: array
Title: Preview Subscription Charges
Preview subscriptions lets you view amended subscription product charges before creating, updating, or deleting a subscription.
Show Source
Nested Schema : Preview Subscription Bill Lines
Type: array
Title: Preview Subscription Bill Lines
Preview subscriptions lets you view subscription product details before creating, updating, or deleting a subscription.
Show Source
Nested Schema : previewSubscriptions-products-amendedProduct-item-response
Type: object
Show Source
Nested Schema : Preview Subscription Charges
Type: array
Title: Preview Subscription Charges
Preview subscriptions lets you view amended subscription product charges before creating, updating, or deleting a subscription.
Show Source
Nested Schema : Preview Subscription Bill Lines
Type: array
Title: Preview Subscription Bill Lines
Preview subscriptions lets you view subscription product details before creating, updating, or deleting a subscription.
Show Source
Nested Schema : previewSubscriptions-products-amendedProduct-charges-item-response
Type: object
Show Source
Nested Schema : Subscription Charge Adjustment
Type: array
Title: Subscription Charge Adjustment
Show Source
Nested Schema : previewSubscriptions-products-amendedProduct-charges-adjustments-item-response
Type: object
Show Source
Nested Schema : previewSubscriptions-products-amendedProduct-output-item-response
Type: object
Show Source
Nested Schema : previewSubscriptions-products-charges-item-response
Type: object
Show Source
Nested Schema : Subscription Charge Adjustment
Type: array
Title: Subscription Charge Adjustment
Show Source
Nested Schema : previewSubscriptions-products-charges-adjustments-item-response
Type: object
Show Source
Nested Schema : previewSubscriptions-products-output-item-response
Type: object
Show Source
Back to Top

Examples

The following example shows how to create a subsciption preview by submitting a POST request on the REST resource.

You can create subscription preview with pre-priced charges, based on rate plan, and also close and create a new preview.

Create subscription preview with pre-priced charges

The following example shows how to create a subscription preview with pre-priced charges.

Example URL:

https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/previewSubscriptions

Example of Request Body

{
  "BusinessUnitId": 204,
  "LegalEntityId": 204,
  "SubscriptionProfileName": "zOSS_SP_ServiceStartActual_Advance_Month",
  "PrimaryPartyId": 1006,
  "Currency": "USD",
  "StartDate": "2024-01-01",
  "EndDate": "2024-12-31",
  "BillToAccountId": 1006,
  "BillToSiteUseId": 10921,
  "TaxClassificationCode": "VAT20",
  "products": [
    {
      "ActionCode": "BILLGENERATION",
      "ProductName": "ZOSS_SubscriptionItem002_AUTO",
      //"ProductName": "Fiber Connect",
      "Quantity": 1,
      "StartDate": "2024-01-01",
      "EndDate": "2024-06-30",
      "BillingFrequency": "0zF",
      "charges": [
        {
          "ChargeName": "Service Fee",
          "ChargeDefinition": "ZOKCRECURRINCHARGE",
          "PricePeriodicity": "0zG",
          "PriceType": "RECURRING",
          "UnitListPrice": 20000,
          "adjustments": [
            {
              "AdjustmentName": "Adj1",
              "AdjustmentType": "ORA_PRICE_OVERRIDE",
              "AdjustmentValue": 100,
              "AutoAdjustmentFlag": false,
              "Effectivity": "ORA_ALL_TERM"
            }
          ]
        }
      ],
      "output": [
        {
          "NumberOfBillingCycles": 2
        }
      ]
    }
  ]
}

Example of Response Body

{
    "SubscriptionId": 300100635171996,
    "SubscriptionNumber": "Preview_2025-03-26 10:17:40.435",
    "Currency": "USD",
    "BusinessUnitId": 204,
    "SubscriptionProfileName": "zOSS_SP_ServiceStartActual_Advance_Month",
    "PrimaryPartyId": 1006,
    "BillToAccountId": 1006,
    "BillToSiteUseId": 10921,
    "PrimaryPartyNumber": null,
    "BillToAccountNumber": null,
    "BillToSiteNumber": null,
    "PricingStrategyId": null,
    "StartDate": "2024-01-01",
    "EndDate": "2024-12-31",
    "TaxClassificationCode": "VAT20",
    "ExemptCertificateNumber": null,
    "LegalEntityId": 204,
    "DocumentFiscalClassification": null,
    "ShipToPartyNumber": null,
    "ShipToParty": null,
    "products": [
        {
            "ActionCode": "BILLGENERATION",
            "ProductName": "ZOSS_SubscriptionItem002_AUTO",
            "InventoryItemId": null,
            "DefinitionOrganizationId": null,
            "SalesProductType": null,
            "Quantity": 1,
            "ItemUnitOfMeasure": null,
            "StartDate": "2024-01-01",
            "EndDate": "2024-06-30",
            "BillingFrequency": "0zF",
            "RequestedRatePlanId": null,
            "RequestedRatePlanNumber": null,
            "PriceListId": null,
            "EstimatedTax": 120,
            "ExemptCertificateNumber": null,
            "OutputTaxClassification": null,
            "ProductFiscClassification": null,
            "TotalContractValue": null,
            "AlignBillingFrom": null,
            "RequestedAlignBillingDate": null,
            "SubscriptionProductPuid": null,
            "CloseReason": null,
            "CloseCreditMethod": null,
            "ClosedDate": null,
            "charges": [
                {
                    "ChargeName": "Service Fee",
                    "ChargeDefinition": "ZOKCRECURRINCHARGE",
                    "PriceType": "RECURRING",
                    "PricePeriodicity": "0zG",
                    "UnitListPrice": 20000,
                    "BillingFreq": null,
                    "EstimatedAmount": null,
                    "EstimatedQuantity": null,
                    "EstimationMethod": null,
                    "InvoicingRuleId": null,
                    "PeriodicBillingFlag": null,
                    "QuotedTcv": null,
                    "adjustments": [
                        {
                            "AdjustmentType": "ORA_PRICE_OVERRIDE",
                            "AdjustmentValue": 100,
                            "SequenceNumber": null,
                            "AdjustmentName": "Adj1",
                            "Effectivity": "ORA_ALL_TERM",
                            "AutoAdjustmentFlag": false,
                            "PeriodFrom": null,
                            "PeriodUntil": null,
                            "NumberOfPeriods": null,
                            "AdjustmentBasis": null,
                            "links": [
                                {
                                    "rel": "self",
                                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/previewSubscriptions/300100635171996/child/products/300100635171999/child/charges/300100635172000/child/adjustments/300100635172001",
                                    "name": "adjustments",
                                    "kind": "item"
                                },
                                {
                                    "rel": "canonical",
                                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/previewSubscriptions/300100635171996/child/products/300100635171999/child/charges/300100635172000/child/adjustments/300100635172001",
                                    "name": "adjustments",
                                    "kind": "item"
                                },
                                {
                                    "rel": "parent",
                                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/previewSubscriptions/300100635171996/child/products/300100635171999/child/charges/300100635172000",
                                    "name": "charges",
                                    "kind": "item"
                                }
                            ]
                        }
                    ],
                    "links": [
                        {
                            "rel": "self",
                            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/previewSubscriptions/300100635171996/child/products/300100635171999/child/charges/300100635172000",
                            "name": "charges",
                            "kind": "item"
                        },
                        {
                            "rel": "canonical",
                            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/previewSubscriptions/300100635171996/child/products/300100635171999/child/charges/300100635172000",
                            "name": "charges",
                            "kind": "item"
                        },
                        {
                            "rel": "parent",
                            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/previewSubscriptions/300100635171996/child/products/300100635171999",
                            "name": "products",
                            "kind": "item"
                        },
                        {
                            "rel": "child",
                            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/previewSubscriptions/300100635171996/child/products/300100635171999/child/charges/300100635172000/child/adjustments",
                            "name": "adjustments",
                            "kind": "collection"
                        }
                    ]
                }
            ],
            "output": [
                {
                    "NumberOfBillingCycles": 2,
                    "BillLineHeader": "ChargeName,DateBilledFrom,DateBilledTo,InvoiceDate,DateToInterface,Amount",
                    "BillLineValues": "[{'ChargeName':'Service Fee','DateBilledFrom':'2024-01-01','DateBilledTo':'2024-01-31','InvoiceDate':'2024-01-01','DateToInterface':'2024-01-01','Amount':'100'},{'ChargeName':'Service Fee','DateBilledFrom':'2024-02-01','DateBilledTo':'2024-02-29','InvoiceDate':'2024-01-01','DateToInterface':'2024-01-01','Amount':'100'},{'ChargeName':'Service Fee','DateBilledFrom':'2024-03-01','DateBilledTo':'2024-03-31','InvoiceDate':'2024-01-01','DateToInterface':'2024-01-01','Amount':'100'},{'ChargeName':'Service Fee','DateBilledFrom':'2024-04-01','DateBilledTo':'2024-04-30','InvoiceDate':'2024-04-01','DateToInterface':'2024-04-01','Amount':'100'},{'ChargeName':'Service Fee','DateBilledFrom':'2024-05-01','DateBilledTo':'2024-05-31','InvoiceDate':'2024-04-01','DateToInterface':'2024-04-01','Amount':'100'},{'ChargeName':'Service Fee','DateBilledFrom':'2024-06-01','DateBilledTo':'2024-06-30','InvoiceDate':'2024-04-01','DateToInterface':'2024-04-01','Amount':'100'}]",
                    "ChargeHeader": null,
                    "ChargeValues": null,
                    "ChargeAdjustmentHeader": null,
                    "links": [
                        {
                            "rel": "self",
                            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/previewSubscriptions/300100635171996/child/products/300100635171999/child/output/300100635171999",
                            "name": "output",
                            "kind": "item"
                        },
                        {
                            "rel": "canonical",
                            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/previewSubscriptions/300100635171996/child/products/300100635171999/child/output/300100635171999",
                            "name": "output",
                            "kind": "item"
                        },
                        {
                            "rel": "parent",
                            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/previewSubscriptions/300100635171996/child/products/300100635171999",
                            "name": "products",
                            "kind": "item"
                        }
                    ]
                }
            ],
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/previewSubscriptions/300100635171996/child/products/300100635171999",
                    "name": "products",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/previewSubscriptions/300100635171996/child/products/300100635171999",
                    "name": "products",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/previewSubscriptions/300100635171996",
                    "name": "previewSubscriptions",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/previewSubscriptions/300100635171996/child/products/300100635171999/child/charges",
                    "name": "charges",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/previewSubscriptions/300100635171996/child/products/300100635171999/child/output",
                    "name": "output",
                    "kind": "collection"
                }
            ]
        }
    ],
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/previewSubscriptions/300100635171996",
            "name": "previewSubscriptions",
            "kind": "item"
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/previewSubscriptions/300100635171996",
            "name": "previewSubscriptions",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/previewSubscriptions/300100635171996/child/products",
            "name": "products",
            "kind": "collection"
        }
    ]
}

Create subscription preview with pricing call

This example shows how to create a subscription preview with pricing call.

Example URL:

https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/previewSubscriptions

Example of Request Body

{
"BusinessUnitId": 204,
  "LegalEntityId": 204,
  "SubscriptionProfileName": "zOSS_SP_ServiceStartActual_Advance_Month",
  "PrimaryPartyId": 1006,
  "Currency": "USD",
  "StartDate": "2024-01-01",
  "EndDate": "2024-12-31",
  "BillToAccountId": 1006,
  "BillToSiteUseId": 10921,
  "TaxClassificationCode": "VAT20",
  "products": [
    {
      "ActionCode": "PRICING",
      "ProductName": "ZOSS_SubscriptionItem003_AUTO",
      "Quantity": 1,
      "StartDate": "2024-01-01",
      "EndDate": "2024-12-31",
      "BillingFrequency": "0zG",
      "output": [
        {
            
        }
      ]
    }
  ]
}

Example of Response Body

{
    "SubscriptionId": 300100635172005,
    "SubscriptionNumber": "Preview_2025-03-26 10:18:51.556",
    "Currency": "USD",
    "BusinessUnitId": 204,
    "SubscriptionProfileName": "zOSS_SP_ServiceStartActual_Advance_Month",
    "PrimaryPartyId": 1006,
    "BillToAccountId": 1006,
    "BillToSiteUseId": 10921,
    "PrimaryPartyNumber": null,
    "BillToAccountNumber": null,
    "BillToSiteNumber": null,
    "PricingStrategyId": null,
    "StartDate": "2024-01-01",
    "EndDate": "2024-12-31",
    "TaxClassificationCode": "VAT20",
    "ExemptCertificateNumber": null,
    "LegalEntityId": 204,
    "DocumentFiscalClassification": null,
    "ShipToPartyNumber": null,
    "ShipToParty": null,
    "products": [
        {
            "ActionCode": "PRICING",
            "ProductName": "ZOSS_SubscriptionItem003_AUTO",
            "InventoryItemId": null,
            "DefinitionOrganizationId": null,
            "SalesProductType": null,
            "Quantity": 1,
            "ItemUnitOfMeasure": null,
            "StartDate": "2024-01-01",
            "EndDate": "2024-12-31",
            "BillingFrequency": "0zG",
            "RequestedRatePlanId": null,
            "RequestedRatePlanNumber": null,
            "PriceListId": null,
            "EstimatedTax": 1320,
            "ExemptCertificateNumber": null,
            "OutputTaxClassification": null,
            "ProductFiscClassification": null,
            "TotalContractValue": null,
            "AlignBillingFrom": null,
            "RequestedAlignBillingDate": null,
            "SubscriptionProductPuid": null,
            "CloseReason": null,
            "CloseCreditMethod": null,
            "ClosedDate": null,
            "output": [
                {
                    "NumberOfBillingCycles": null,
                    "BillLineHeader": "ChargeName,DateBilledFrom,DateBilledTo,InvoiceDate,DateToInterface,Amount",
                    "BillLineValues": "[{'ChargeName':'Activation Fee','DateBilledFrom':'2024-01-01','DateBilledTo':'2024-12-31','InvoiceDate':'2024-01-01','DateToInterface':'2024-01-01','Amount':'3000'},{'ChargeName':'Monthly Fee','DateBilledFrom':'2024-01-01','DateBilledTo':'2024-01-31','InvoiceDate':'2024-01-01','DateToInterface':'2024-01-01','Amount':'300'},{'ChargeName':'USAGE SPM CHARGE','DateBilledFrom':'2024-01-01','DateBilledTo':'2024-01-31','InvoiceDate':'2024-02-01','DateToInterface':'2024-02-01','Amount':'0'},{'ChargeName':'Monthly Fee','DateBilledFrom':'2024-02-01','DateBilledTo':'2024-02-29','InvoiceDate':'2024-02-01','DateToInterface':'2024-02-01','Amount':'300'},{'ChargeName':'USAGE SPM CHARGE','DateBilledFrom':'2024-02-01','DateBilledTo':'2024-02-29','InvoiceDate':'2024-03-01','DateToInterface':'2024-03-01','Amount':'0'},{'ChargeName':'Monthly Fee','DateBilledFrom':'2024-03-01','DateBilledTo':'2024-03-31','InvoiceDate':'2024-03-01','DateToInterface':'2024-03-01','Amount':'300'},{'ChargeName':'USAGE SPM CHARGE','DateBilledFrom':'2024-03-01','DateBilledTo':'2024-03-31','InvoiceDate':'2024-04-01','DateToInterface':'2024-04-01','Amount':'0'},{'ChargeName':'Monthly Fee','DateBilledFrom':'2024-04-01','DateBilledTo':'2024-04-30','InvoiceDate':'2024-04-01','DateToInterface':'2024-04-01','Amount':'300'},{'ChargeName':'USAGE SPM CHARGE','DateBilledFrom':'2024-04-01','DateBilledTo':'2024-04-30','InvoiceDate':'2024-05-01','DateToInterface':'2024-05-01','Amount':'0'},{'ChargeName':'Monthly Fee','DateBilledFrom':'2024-05-01','DateBilledTo':'2024-05-31','InvoiceDate':'2024-05-01','DateToInterface':'2024-05-01','Amount':'300'},{'ChargeName':'USAGE SPM CHARGE','DateBilledFrom':'2024-05-01','DateBilledTo':'2024-05-31','InvoiceDate':'2024-06-01','DateToInterface':'2024-06-01','Amount':'0'},{'ChargeName':'Monthly Fee','DateBilledFrom':'2024-06-01','DateBilledTo':'2024-06-30','InvoiceDate':'2024-06-01','DateToInterface':'2024-06-01','Amount':'300'},{'ChargeName':'USAGE SPM CHARGE','DateBilledFrom':'2024-06-01','DateBilledTo':'2024-06-30','InvoiceDate':'2024-07-01','DateToInterface':'2024-07-01','Amount':'0'},{'ChargeName':'Monthly Fee','DateBilledFrom':'2024-07-01','DateBilledTo':'2024-07-31','InvoiceDate':'2024-07-01','DateToInterface':'2024-07-01','Amount':'300'},{'ChargeName':'USAGE SPM CHARGE','DateBilledFrom':'2024-07-01','DateBilledTo':'2024-07-31','InvoiceDate':'2024-08-01','DateToInterface':'2024-08-01','Amount':'0'},{'ChargeName':'Monthly Fee','DateBilledFrom':'2024-08-01','DateBilledTo':'2024-08-31','InvoiceDate':'2024-08-01','DateToInterface':'2024-08-01','Amount':'300'},{'ChargeName':'USAGE SPM CHARGE','DateBilledFrom':'2024-08-01','DateBilledTo':'2024-08-31','InvoiceDate':'2024-09-01','DateToInterface':'2024-09-01','Amount':'0'},{'ChargeName':'Monthly Fee','DateBilledFrom':'2024-09-01','DateBilledTo':'2024-09-30','InvoiceDate':'2024-09-01','DateToInterface':'2024-09-01','Amount':'300'},{'ChargeName':'USAGE SPM CHARGE','DateBilledFrom':'2024-09-01','DateBilledTo':'2024-09-30','InvoiceDate':'2024-10-01','DateToInterface':'2024-10-01','Amount':'0'},{'ChargeName':'Monthly Fee','DateBilledFrom':'2024-10-01','DateBilledTo':'2024-10-31','InvoiceDate':'2024-10-01','DateToInterface':'2024-10-01','Amount':'300'},{'ChargeName':'USAGE SPM CHARGE','DateBilledFrom':'2024-10-01','DateBilledTo':'2024-10-31','InvoiceDate':'2024-11-01','DateToInterface':'2024-11-01','Amount':'0'},{'ChargeName':'Monthly Fee','DateBilledFrom':'2024-11-01','DateBilledTo':'2024-11-30','InvoiceDate':'2024-11-01','DateToInterface':'2024-11-01','Amount':'300'},{'ChargeName':'USAGE SPM CHARGE','DateBilledFrom':'2024-11-01','DateBilledTo':'2024-11-30','InvoiceDate':'2024-12-01','DateToInterface':'2024-12-01','Amount':'0'},{'ChargeName':'Monthly Fee','DateBilledFrom':'2024-12-01','DateBilledTo':'2024-12-31','InvoiceDate':'2024-12-01','DateToInterface':'2024-12-01','Amount':'300'},{'ChargeName':'USAGE SPM CHARGE','DateBilledFrom':'2024-12-01','DateBilledTo':'2024-12-31','InvoiceDate':'2025-01-01','DateToInterface':'2025-01-01','Amount':'0'}]",
                    "ChargeHeader": "ChargeName,ChargeDefinition,PricePeriodicity,PriceType,UnitListPrice,BillingFreq,EstimatedAmount,EstimatedQuantity,EstimationMethod,InvoicingRuleId,PeriodicBillingFlag,QuotedTcv",
                    "ChargeValues": "[{'ChargeName':'Activation Fee','ChargeDefinition':'ACTIVATIONFEE','PriceType':'ONE_TIME','UnitListPrice':'3000','EstimationMethod':'ORA_OSS_USAGE_EST_NONE','adjustments':{}},{'ChargeName':'Monthly Fee','ChargeDefinition':'MONTHLYFEE','PricePeriodicity':'0zG','PriceType':'RECURRING','UnitListPrice':'300','EstimationMethod':'ORA_OSS_USAGE_EST_NONE','adjustments':{}},{'ChargeName':'USAGE SPM CHARGE','ChargeDefinition':'USAGE_CHARGESPM','PricePeriodicity':'0zG','PriceType':'RECURRING','UnitListPrice':'20','EstimationMethod':'ORA_OSS_USAGE_EST_NONE','adjustments':{}}]",
                    "ChargeAdjustmentHeader": "AdjustmentType,AdjustmentValue,SequenceNumber,AdjustmentName,Effectivity,AutoAdjustmentFlag,PeriodFrom,PeriodUntil,NumberOfPeriods,AdjustmentBasis",
                    "links": [
                        {
                            "rel": "self",
                            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/previewSubscriptions/300100635172005/child/products/300100635172008/child/output/300100635172008",
                            "name": "output",
                            "kind": "item"
                        },
                        {
                            "rel": "canonical",
                            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/previewSubscriptions/300100635172005/child/products/300100635172008/child/output/300100635172008",
                            "name": "output",
                            "kind": "item"
                        },
                        {
                            "rel": "parent",
                            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/previewSubscriptions/300100635172005/child/products/300100635172008",
                            "name": "products",
                            "kind": "item"
                        }
                    ]
                }
            ],
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/previewSubscriptions/300100635172005/child/products/300100635172008",
                    "name": "products",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/previewSubscriptions/300100635172005/child/products/300100635172008",
                    "name": "products",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/previewSubscriptions/300100635172005",
                    "name": "previewSubscriptions",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/previewSubscriptions/300100635172005/child/products/300100635172008/child/charges",
                    "name": "charges",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/previewSubscriptions/300100635172005/child/products/300100635172008/child/output",
                    "name": "output",
                    "kind": "collection"
                }
            ]
        }
    ],
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/previewSubscriptions/300100635172005",
            "name": "previewSubscriptions",
            "kind": "item"
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/previewSubscriptions/300100635172005",
            "name": "previewSubscriptions",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/previewSubscriptions/300100635172005/child/products",
            "name": "products",
            "kind": "collection"
        }
    ]
}

Create preview subscription based on rate plans

This example shows how to create preview subscriptions based on rate plans by submitting a POST request on the REST resource using cURL.

Example URL:

https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/previewSubscriptions

Example of Request Body

{
  "BusinessUnitId": 204,
  "LegalEntityId": 204,
  "SubscriptionProfileName": "zOSS_SP_ServiceStartActual_Advance_Month",
  "PrimaryPartyId": 1006,
  "Currency": "USD",
  "StartDate": "2024-01-01",
  "EndDate": "2024-12-31",
  "BillToAccountId": 1006,
  "BillToSiteUseId": 10921,
  "TaxClassificationCode": "VAT20",
    "products": [
      
        {
      "ActionCode": "PRICING",
      "ProductName": "Fiber Connect",
      "RequestedRatePlanId": 300100573915062,
      "Quantity": 1,
      "StartDate": "2024-01-01",
      "EndDate": "2024-12-31",
      "BillingFrequency": "0zG",
      "output": [
        {
            "NumberOfBillingCycles": 2
        }
      ]
        }
    ]
}

Example of Response Body

{
    "SubscriptionId": 300100630645662,
    "SubscriptionNumber": "Preview_sub_1",
    "Currency": "INR",
    "BusinessUnitId": 204,
    "SubscriptionProfileName": "zOSS_SP_ServiceStartActual_Advance_Month",
    "PrimaryPartyId": 1001,
    "BillToAccountId": 1006,
    "BillToSiteUseId": 1025,
    "PrimaryPartyNumber": "1001",
    "BillToAccountNumber": "1006",
    "BillToSiteNumber": "Chattanooga (OPS)",
    "PricingStrategyId": null,
    "StartDate": "2024-12-01",
    "EndDate": "2026-12-31",
    "TaxClassificationCode": "VAT20",
    "ExemptCertificateNumber": null,
    "LegalEntityId": 204,
    "DocumentFiscalClassification": null,
    "ShipToPartyNumber": "1001",
    "ShipToParty": 1001,
    "products": [
        {
            "ActionCode": "CLOSE",
            "ProductName": null,
            "InventoryItemId": null,
            "DefinitionOrganizationId": null,
            "SalesProductType": null,
            "Quantity": 1,
            "ItemUnitOfMeasure": null,
            "StartDate": "2024-12-01",
            "EndDate": "2026-12-31",
            "BillingFrequency": "0zG",
            "RequestedRatePlanId": null,
            "RequestedRatePlanNumber": null,
            "PriceListId": null,
            "EstimatedTax": 2200,
            "ExemptCertificateNumber": null,
            "OutputTaxClassification": null,
            "ProductFiscClassification": null,
            "TotalContractValue": null,
            "AlignBillingFrom": null,
            "RequestedAlignBillingDate": null,
            "SubscriptionProductPuid": "Preview_sub_1-PRDT-36428",
            "CloseReason": "ORA_BREACH",
            "CloseCreditMethod": "ORA_PRORATE_WITH_CREDIT",
            "ClosedDate": "2025-06-20",
            "output": [
                {
                    "NumberOfBillingCycles": null,
                    "BillLineHeader": "ChargeName,DateBilledFrom,DateBilledTo,InvoiceDate,DateToInterface,Amount",
                    "BillLineValues": "[{'ChargeName':'Activation Fee','DateBilledFrom':'2024-12-01','DateBilledTo':'2026-12-31','InvoiceDate':'2024-12-01','DateToInterface':'2024-12-01','Amount':'1000'},{'ChargeName':'Monthly Fee','DateBilledFrom':'2024-12-01','DateBilledTo':'2024-12-31','InvoiceDate':'2024-12-01','DateToInterface':'2024-12-01','Amount':'100'},{'ChargeName':'QTR Fee','DateBilledFrom':'2024-12-01','DateBilledTo':'2024-12-31','InvoiceDate':'2024-12-01','DateToInterface':'2024-12-01','Amount':'200'},{'ChargeName':'Year Fee','DateBilledFrom':'2024-12-01','DateBilledTo':'2024-12-31','InvoiceDate':'2024-12-01','DateToInterface':'2024-12-01','Amount':'100'},{'ChargeName':'QTR Fee','DateBilledFrom':'2025-01-01','DateBilledTo':'2025-01-31','InvoiceDate':'2025-01-01','DateToInterface':'2025-01-01','Amount':'200'},{'ChargeName':'Year Fee','DateBilledFrom':'2025-01-01','DateBilledTo':'2025-01-31','InvoiceDate':'2025-01-01','DateToInterface':'2025-01-01','Amount':'100'},{'ChargeName':'Monthly Fee','DateBilledFrom':'2025-01-01','DateBilledTo':'2025-01-31','InvoiceDate':'2025-01-01','DateToInterface':'2025-01-01','Amount':'100'},{'ChargeName':'QTR Fee','DateBilledFrom':'2025-02-01','DateBilledTo':'2025-02-28','InvoiceDate':'2025-02-01','DateToInterface':'2025-02-01','Amount':'200'},{'ChargeName':'Year Fee','DateBilledFrom':'2025-02-01','DateBilledTo':'2025-02-28','InvoiceDate':'2025-02-01','DateToInterface':'2025-02-01','Amount':'100'},{'ChargeName':'Monthly Fee','DateBilledFrom':'2025-02-01','DateBilledTo':'2025-02-28','InvoiceDate':'2025-02-01','DateToInterface':'2025-02-01','Amount':'100'},{'ChargeName':'Year Fee','DateBilledFrom':'2025-03-01','DateBilledTo':'2025-03-31','InvoiceDate':'2025-03-01','DateToInterface':'2025-03-01','Amount':'100'},{'ChargeName':'QTR Fee','DateBilledFrom':'2025-03-01','DateBilledTo':'2025-03-31','InvoiceDate':'2025-03-01','DateToInterface':'2025-03-01','Amount':'200'},{'ChargeName':'Monthly Fee','DateBilledFrom':'2025-03-01','DateBilledTo':'2025-03-31','InvoiceDate':'2025-03-01','DateToInterface':'2025-03-01','Amount':'100'},{'ChargeName':'Year Fee','DateBilledFrom':'2025-04-01','DateBilledTo':'2025-04-30','InvoiceDate':'2025-04-01','DateToInterface':'2025-04-01','Amount':'100'},{'ChargeName':'QTR Fee','DateBilledFrom':'2025-04-01','DateBilledTo':'2025-04-30','InvoiceDate':'2025-04-01','DateToInterface':'2025-04-01','Amount':'200'},{'ChargeName':'Monthly Fee','DateBilledFrom':'2025-04-01','DateBilledTo':'2025-04-30','InvoiceDate':'2025-04-01','DateToInterface':'2025-04-01','Amount':'100'},{'ChargeName':'Year Fee','DateBilledFrom':'2025-05-01','DateBilledTo':'2025-05-31','InvoiceDate':'2025-05-01','DateToInterface':'2025-05-01','Amount':'100'},{'ChargeName':'QTR Fee','DateBilledFrom':'2025-05-01','DateBilledTo':'2025-05-31','InvoiceDate':'2025-05-01','DateToInterface':'2025-05-01','Amount':'200'},{'ChargeName':'Monthly Fee','DateBilledFrom':'2025-05-01','DateBilledTo':'2025-05-31','InvoiceDate':'2025-05-01','DateToInterface':'2025-05-01','Amount':'100'},{'ChargeName':'Year Fee','DateBilledFrom':'2025-06-01','DateBilledTo':'2025-06-19','InvoiceDate':'2025-06-01','DateToInterface':'2025-06-01','Amount':'63.33'},{'ChargeName':'QTR Fee','DateBilledFrom':'2025-06-01','DateBilledTo':'2025-06-19','InvoiceDate':'2025-06-01','DateToInterface':'2025-06-01','Amount':'126.67'},{'ChargeName':'Monthly Fee','DateBilledFrom':'2025-06-01','DateBilledTo':'2025-06-19','InvoiceDate':'2025-06-01','DateToInterface':'2025-06-01','Amount':'63.33'}]",
                    "ChargeHeader": null,
                    "ChargeValues": null,
                    "ChargeAdjustmentHeader": null
                }
            ]
        },
        {
            "ActionCode": "PRICING",
            "ProductName": "ZOSS_SubscriptionItem002_AUTO",
            "InventoryItemId": null,
            "DefinitionOrganizationId": null,
            "SalesProductType": null,
            "Quantity": 1,
            "ItemUnitOfMeasure": null,
            "StartDate": "2025-06-21",
            "EndDate": "2025-12-31",
            "BillingFrequency": "0zF",
            "RequestedRatePlanId": null,
            "RequestedRatePlanNumber": null,
            "PriceListId": null,
            "EstimatedTax": 32382.58,
            "ExemptCertificateNumber": null,
            "OutputTaxClassification": null,
            "ProductFiscClassification": null,
            "TotalContractValue": null,
            "AlignBillingFrom": null,
            "RequestedAlignBillingDate": null,
            "SubscriptionProductPuid": null,
            "CloseReason": null,
            "CloseCreditMethod": null,
            "ClosedDate": null,
            "output": [
                {
                    "NumberOfBillingCycles": null,
                    "BillLineHeader": "ChargeName,DateBilledFrom,DateBilledTo,InvoiceDate,DateToInterface,Amount",
                    "BillLineValues": "[{'ChargeName':'Activation Fee','DateBilledFrom':'2025-06-21','DateBilledTo':'2025-12-31','InvoiceDate':'2025-06-21','DateToInterface':'2025-06-21','Amount':'99000'},{'ChargeName':'Monthly Fee','DateBilledFrom':'2025-06-21','DateBilledTo':'2025-07-20','InvoiceDate':'2025-06-21','DateToInterface':'2025-06-21','Amount':'9900'},{'ChargeName':'USAGE SPM CHARGE','DateBilledFrom':'2025-06-21','DateBilledTo':'2025-07-20','InvoiceDate':'2025-09-21','DateToInterface':'2025-09-21','Amount':'0'},{'ChargeName':'Monthly Fee','DateBilledFrom':'2025-07-21','DateBilledTo':'2025-08-20','InvoiceDate':'2025-06-21','DateToInterface':'2025-06-21','Amount':'9900'},{'ChargeName':'USAGE SPM CHARGE','DateBilledFrom':'2025-07-21','DateBilledTo':'2025-08-20','InvoiceDate':'2025-09-21','DateToInterface':'2025-09-21','Amount':'0'},{'ChargeName':'Monthly Fee','DateBilledFrom':'2025-08-21','DateBilledTo':'2025-09-20','InvoiceDate':'2025-06-21','DateToInterface':'2025-06-21','Amount':'9900'},{'ChargeName':'USAGE SPM CHARGE','DateBilledFrom':'2025-08-21','DateBilledTo':'2025-09-20','InvoiceDate':'2025-09-21','DateToInterface':'2025-09-21','Amount':'0'},{'ChargeName':'Monthly Fee','DateBilledFrom':'2025-09-21','DateBilledTo':'2025-10-20','InvoiceDate':'2025-09-21','DateToInterface':'2025-09-21','Amount':'9900'},{'ChargeName':'USAGE SPM CHARGE','DateBilledFrom':'2025-09-21','DateBilledTo':'2025-10-20','InvoiceDate':'2025-12-21','DateToInterface':'2025-12-21','Amount':'0'},{'ChargeName':'Monthly Fee','DateBilledFrom':'2025-10-21','DateBilledTo':'2025-11-20','InvoiceDate':'2025-09-21','DateToInterface':'2025-09-21','Amount':'9900'},{'ChargeName':'USAGE SPM CHARGE','DateBilledFrom':'2025-10-21','DateBilledTo':'2025-11-20','InvoiceDate':'2025-12-21','DateToInterface':'2025-12-21','Amount':'0'},{'ChargeName':'Monthly Fee','DateBilledFrom':'2025-11-21','DateBilledTo':'2025-12-20','InvoiceDate':'2025-09-21','DateToInterface':'2025-09-21','Amount':'9900'},{'ChargeName':'USAGE SPM CHARGE','DateBilledFrom':'2025-11-21','DateBilledTo':'2025-12-20','InvoiceDate':'2025-12-21','DateToInterface':'2025-12-21','Amount':'0'},{'ChargeName':'Monthly Fee','DateBilledFrom':'2025-12-21','DateBilledTo':'2025-12-31','InvoiceDate':'2025-12-21','DateToInterface':'2025-12-21','Amount':'3512.9'},{'ChargeName':'USAGE SPM CHARGE','DateBilledFrom':'2025-12-21','DateBilledTo':'2025-12-31','InvoiceDate':'2026-01-01','DateToInterface':'2026-01-01','Amount':'0'}]",
                    "ChargeHeader": "ChargeName,ChargeDefinition,PricePeriodicity,PriceType,UnitListPrice,BillingFreq,EstimatedAmount,EstimatedQuantity,EstimationMethod,InvoicingRuleId,PeriodicBillingFlag,QuotedTcv",
                    "ChargeValues": "[{'ChargeName':'USAGE SPM CHARGE','ChargeDefinition':'USAGE_CHARGESPM','PricePeriodicity':'0zG','PriceType':'RECURRING','UnitListPrice':'495','EstimationMethod':'ORA_OSS_USAGE_EST_NONE','adjustments':{}},{'ChargeName':'Monthly Fee','ChargeDefinition':'MONTHLYFEE','PricePeriodicity':'0zG','PriceType':'RECURRING','UnitListPrice':'9900','EstimationMethod':'ORA_OSS_USAGE_EST_NONE','adjustments':{}},{'ChargeName':'Activation Fee','ChargeDefinition':'ACTIVATIONFEE','PriceType':'ONE_TIME','UnitListPrice':'99000','EstimationMethod':'ORA_OSS_USAGE_EST_NONE','adjustments':{}}]",
                    "ChargeAdjustmentHeader": "AdjustmentType,AdjustmentValue,SequenceNumber,AdjustmentName,Effectivity,AutoAdjustmentFlag,PeriodFrom,PeriodUntil,NumberOfPeriods,AdjustmentBasis"
                }
            ]
        }
    ]
}
Back to Top