1. REST Services Manager API for Billing and Revenue Management
  2. Tasks
  3. Order Billing Fulfillment

Perform Billing Fulfillment

post

/createFulfillBilling

Performs the following bill fulfillment processes:
  • Purchases a product offering, such as a bundled offer, charge offer, or a discount offer
  • Suspends a purchased service
  • Resumes a suspended service
  • Terminates a purchased product offering

You specify the type of operation to be performed using the productOrderItem.action field in the request payload. Set the field to add, terminate, suspend, or resume.

You can also specify to cancel the service in the future by setting the productOrderItem.requestedCompletionDate field to a future-dated timestamp.

If you support two-phase billing, then you can also specify the offer be purchased with a future activation date using the billFulfillMode field in the request payload. Set the field to initiate to purchase an offer with the start dates set to 365 days in the future, or to fulfill to update the start dates to actual activation dates provided in the payload.

Request

There are no request parameters for this operation.

Supported Media Types
Request Body - application/json;charset=utf-8 ()
Root Schema : schema
Type: object
Initiates the performance of billing fulfillment.
Show Source
Nested Schema : Billing Account Ref
Type: object
Title: Billing Account Ref
A billing account is a detailed description of a bill structure.
Show Source
Nested Schema : PackageRef
Type: object
Represents parent product order name.
Show Source
Nested Schema : productOrderItem
Type: array
Minimum Number of Items: 1
Show Source
  • ProductOrderItem
    It refers to an identified part of the order. A product order is decomposed into one or more order items. Skipped properties: quantity, appointment, billingAccount, itemPrice, itemTerm, itemTotalPrice, payment, productOffering, productOfferingQualificationItem, productOrderItem, productOrderItemRelationship, qualification, quoteItem, state, @baseType, @schemaLocation, @type
Nested Schema : ProductOrderItem
Type: object
It refers to an identified part of the order. A product order is decomposed into one or more order items. Skipped properties: quantity, appointment, billingAccount, itemPrice, itemTerm, itemTotalPrice, payment, productOffering, productOfferingQualificationItem, productOrderItem, productOrderItemRelationship, qualification, quoteItem, state, @baseType, @schemaLocation, @type
Show Source
Nested Schema : itemPrice
Type: array
Show Source
  • ItemPrice
    A list of order prices. It is an amount, usually of money, that represents the actual price paid by the customer for this item.
Nested Schema : itemTotalPrice
Type: array
Show Source
Nested Schema : Product
Type: object
A product offering procured by a customer or other interested party playing a party role. A product is realized as one or more service(s) and / or resource(s). Skipped properties: href, description, isBundle, isCustomerVisible, name, orderDate, productSerialNumber, startDate, terminationDate, agreement, billingAccount, place, product, productOrderItem, productPrice, productSpecification, realizingResource, realizingService, relatedParty, status, baseType, schemaLocation, type.
Show Source
Nested Schema : ProductOfferingRef
Type: object
A reference to the product offering. A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information.
Show Source
Nested Schema : productOrderItem
Type: array
Show Source
  • ProductOrderItem
    It refers to an identified part of the order. A product order is decomposed into one or more order items. Skipped properties: quantity, appointment, billingAccount, itemPrice, itemTerm, itemTotalPrice, payment, productOffering, productOfferingQualificationItem, productOrderItem, productOrderItemRelationship, qualification, quoteItem, state, @baseType, @schemaLocation, @type
Nested Schema : ItemPrice
Type: object
A list of order prices. It is an amount, usually of money, that represents the actual price paid by the customer for this item.
Show Source
  • This defines the sub-class entity name when sub-classing.
  • A narrative that explains in detail the semantics of this order item price.
  • Price
    Provides all amounts (tax included, duty free, tax rate), used currency and percentage to apply for Price Alteration.
  • priceAlteration
    It refers to a strucuture used to describe a price alteration.
  • Allowed Values: [ "recurring", "oneTime", "usage", "/event/billing/product/fee/purchase", "/event/billing/product/fee/cycle/cycle_forward_monthly", "/event/billing/product/fee/cycle/cycle_forward_bimonthly", "/event/billing/product/fee/cycle/cycle_forward_quarterly", "/event/billing/product/fee/cycle/cycle_forward_semiannual", "/event/billing/product/fee/cycle/cycle_forward_annual", "/event/billing/product/fee/cycle/cycle_arrear", "downPayment" ]
    A category that describes the price, such as recurring, discount, allowance, penalty, and so forth.
  • It refers to a time period like month, week, etc.
  • TimePeriod
    A period of time.
  • It refers to a unit of measurement like minutes, gigaBytes, etc.
Nested Schema : Price
Type: object
Provides all amounts (tax included, duty free, tax rate), used currency and percentage to apply for Price Alteration.
Show Source
Nested Schema : priceAlteration
Type: array
It refers to a strucuture used to describe a price alteration.
Show Source
Nested Schema : TimePeriod
Type: object
A period of time.
Show Source
Nested Schema : Money
Type: object
A base / value business entity used to represent money.
Show Source
Nested Schema : PriceAlteration
Type: object
The object is an amount, usually of money, that modifies the price charged for an order item.
Show Source
Nested Schema : ItemTotalPrice
Type: object
Show Source
  • This defines the sub-class entity name when sub-classing.
  • A narrative that explains in detail the semantics of this order total item price, which includes its children.
  • Price
    Provides all amounts (tax included, duty free, tax rate), used currency and percentage to apply for Price Alteration.
  • Allowed Values: [ "recurring", "oneTime", "usage", "/event/billing/product/fee/purchase", "/event/billing/product/fee/cycle/cycle_forward_monthly", "/event/billing/product/fee/cycle/cycle_forward_bimonthly", "/event/billing/product/fee/cycle/cycle_forward_quarterly", "/event/billing/product/fee/cycle/cycle_forward_semiannual", "/event/billing/product/fee/cycle/cycle_forward_annual", "/event/billing/product/fee/cycle/cycle_arrear", "downPayment" ]
    A category that describes the price, such as recurring, discount, allowance, penalty, and so forth.
Nested Schema : OwnerAccount
Type: object
Provides unique identifier of the owner account.
Show Source
Nested Schema : productCharacteristic
Type: array
Show Source
  • Characteristic
    Describes a given characteristic of an object or entity through a name-value pair. Skipped properties: baseType, schemaLocation, referredType
Nested Schema : productTerm
Type: array
Show Source
Nested Schema : ServiceAccount
Type: object
Provides unique identifier of the service account.
Show Source
Nested Schema : Characteristic
Type: object
Describes a given characteristic of an object or entity through a name-value pair. Skipped properties: baseType, schemaLocation, referredType
Show Source
Nested Schema : Any
Type: object
Nested Schema : ProductTerm
Type: object
Description of a product term linked to this product. This represents a commitment with a duration.
Show Source
Nested Schema : Quantity
Type: object
An amount in a given unit.
Show Source
Back to Top

Response

Supported Media Types

200 Response

The billing was fulfilled successfully.

400 Response

The server cannot process the request due to a client error.
Body ()
Root Schema : Error
Type: object
This is used when an API throws an error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source

401 Response

The client does not have the correct privileges.
Body ()
Root Schema : Error
Type: object
This is used when an API throws an error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source

403 Response

The request was not authorized.
Body ()
Root Schema : Error
Type: object
This is used when an API throws an error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source

405 Response

This method is not allowed.
Body ()
Root Schema : Error
Type: object
This is used when an API throws an error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source

409 Response

The request could not be processed due to the conflict with the existing state of the resource.
Body ()
Root Schema : Error
Type: object
This is used when an API throws an error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source

500 Response

The system has encountered an internal server error.
Body ()
Root Schema : Error
Type: object
This is used when an API throws an error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
Back to Top

Examples

Example 1: Initiate Purchase Order of a Bundled Offer

The following example shows how to intiate the purchase order of a bundled offer by submitting a POST request on the REST resource using cURL. For more information about cURL, see Use cURL.

Note:

The productOrderItem.product.id will be used for all subsequent actions, including suspending, resuming, and terminating the services.

The -d option specifies the file to attach as the request body. 

curl -X POST 'http://host:port/brm/orderBillFulfillment/v1/createFulfillBilling' -d @createFulfillBilling.json

Example of Request Body

The following is an example of the contents of the createFulfillBilling.json file sent as the request body. It specifies to:

  • Initiate a purchase order for a Standard GSM Telephony bundle

  • Set the start date of the bundle to 365 days in the future

{
    "billingAccount": {
        "id": "0.0.0.1-139320",
        "accountNumber": "0.0.0.1-132190",
        "name": "o2b_demo19",
        "@type": "value type"
    },
    "productOrderItem": [
        {
            "id": "88-1X6MRX",
            "action": "add",
            "billFulfillMode": "initiate", 
            "productOffering": {
                "id": "88-1X6MRX",
                "name": "Standard GSM Telephony",
                "type": "serviceBundle",
                "@baseType": "ProductOfferingRef",
                "href": "null",
                "@schemaLocation": "null",
                "@type": "ProductOfferingRefOracle"
            },
            "product": {
                "id": "88-1X6RX"
            },
            "productOrderItem": [
                {
                    "id": "88-1X6MR",
                    "action": "add",
                    "productOffering": {
                        "id": "88-1X6MRX",
                        "name": "test",
                        "type": "service",
                        "@baseType": "ProductOfferingRef",
                        "href": "null",
                        "@schemaLocation": "null",
                        "@type": "ProductOfferingRefOracle"
                    },
                    "productOrderItem": [
                        {
                            "id": "88-1X6MR",
                            "action": "add",
                            "productOffering": {
                                "id": "88-1X6MRX",
                                "name": "Standard GSM Telephony",
                                "type": "charge",
                                "@baseType": "ProductOfferingRef",
                                "href": "null",
                                "@schemaLocation": "null",
                                "@type": "ProductOfferingRefOracle"
                            },
                            "itemPrice": [
                                {
                                    "description": "Item Price",
                                    "priceType": "/event/billing/product/fee/purchase",
                                    "timePeriod": {
                                        "startDateTime": "2022-01-21T00:00:00.000Z",
                                        "endDateTime": "2022-01-25T00:00:00.000Z"
                                    },
                                    "priceAlteration": [
                                        {
                                            "name": "PTPurchase1",
                                            "priceType": "priceTag",
                                            "price": {
                                                "dutyFreeAmount": {
                                                    "value": 25,
                                                    "unit": "string"
                                                }
                                            }
                                        }
                                    ]
                                },
                                {
                                    "description": "Item Price",
                                    "priceType": "/event/billing/product/fee/purchase",
                                    "timePeriod": {
                                        "startDateTime": "2023-01-01T00:00:00.000Z",
                                        "endDateTime": "2023-11-31T00:00:00.000Z"
                                    },
                                    "priceAlteration": [
                                        {
                                            "name": "PTPurchase1",
                                            "priceType": "priceTag",
                                            "price": {
                                                "dutyFreeAmount": {
                                                    "value": 15,
                                                    "unit": "string"
                                                }
                                            }
                                        }
                                    ]
                                }
                            ]
                        },
                        {
                            "id": "88-1X6MR",
                            "action": "add",
                            "productOffering": {
                                "id": "88-1X6MRX",
                                "name": "Standard GSM Discount",
                                "type": "discount",
                                "@baseType": "ProductOfferingRef",
                                "href": "null",
                                "@schemaLocation": "null",
                                "@type": "ProductOfferingRefOracle"
                            },
                            "itemPrice": [
                                {
                                    "description": "Item Price",
                                    "priceType": "/event/billing/product/fee/purchase",
                                    "timePeriod": {
                                        "startDateTime": "2022-01-21T00:00:00.000Z",
                                        "endDateTime": "2022-01-25T00:00:00.000Z"
                                    },
                                    "priceAlteration": [
                                        {
                                            "name": "PTPurchase1",
                                            "priceType": "priceTag",
                                            "price": {
                                                "dutyFreeAmount": {
                                                    "value": 25,
                                                    "unit": "string"
                                                }
                                            }
                                        }
                                    ]
                                },
                                {
                                    "description": "Item Price",
                                    "priceType": "/event/billing/product/fee/purchase",
                                    "timePeriod": {
                                        "startDateTime": "2023-01-01T00:00:00.000Z",
                                        "endDateTime": "2023-11-31T00:00:00.000Z"
                                    },
                                    "priceAlteration": [
                                        {
                                            "name": "PTPurchase1",
                                            "priceType": "priceTag",
                                            "price": {
                                                "dutyFreeAmount": {
                                                    "value": 15,
                                                    "unit": "string"
                                                }
                                            }
                                        }
                                    ]
                                }
                            ]
                        }
                    ]
                }
            ]
        }
    ]
}

Example of the Response Body

If successful, the response code 200 is returned with no response body.

Example 2: Fulfill a Purchase Order of a Bundled Offer

The following example shows how to fulfill an order after initiating a bundled offer by submitting a POST request on the REST resource using cURL. For more information about cURL, see Use cURL.

The -d option specifies the file to attach as the request body. 

curl -X POST 'http://host:port/brm/orderBillFulfillment/v1/createFulfillBilling' -d @fulfillServiceBundle.json

Example of Request Body

The following is an example of the contents of the fulfillServiceBundle.json file sent as the request body. It specifies to:

  • Create a purchase order for a Standard GSM Telephony bundle

  • Set the purchase order's start date to November 12, 2024

{
  "billingAccount": {
    "id": "0.0.0.1-53751",
    "accountNumber": "0.0.0.1-136560",
    "name": "accountName1",
    "@type": "BillingAccountRef"
  },
  "productOrderItem": [
    {
      "id": "88-1X6MRX",
      "action": "add",
      "@type": "ProductOrderItem",
      "billFulfillMode": "fulfill",
      "requestedStartDate": "2024-11-12T00:00:00.000Z",
      "productOffering": {
        "id": "88-1X6MRX",
        "name": "Standard GSM Telephony",
        "type": "serviceBundle",
        "@baseType": null,
        "href": null,
        "@schemaLocation": null,
        "@type": "ProductOfferingRefOracle"
      },
      "product": {
        "id": "88-1X6RX",
        "productCharacteristic": [
          {
            "@type": "CharacteristicOracle",
            "name": "Service ID",
            "value": "GSMTelephonySerivce",
            "@baseType": null,
            "@schemaLocation": null,
            "unitOfMeasure": ""
          }
        ],
        "@type": "Product"
      },
      "productOrderItem": [
        {
          "id": "88-1X6MR",
          "action": "add",
          "@type": "ProductOrderItem",
          "productOffering": {
            "id": "88-1X6MRX",
            "name": "test",
            "type": "service",
            "@baseType": null,
            "href": null,
            "@schemaLocation": null,
            "@type": "ProductOfferingRef"
          },
          "productOrderItem": [
            {
              "id": "88-1X6MR",
              "action": "add",
              "@type": "ProductOrderItem",
              "productOffering": {
                "id": "88-1X6MRX",
                "name": "Standard GSM Telephony",
                "type": "charge",
                "@baseType": null,
                "href": null,
                "@schemaLocation": null,
                "@type": "ProductOfferingRef"
              }
            },
            {
              "id": "88-1X6MR",
              "action": "add",
              "@type": "ProductOrderItem",
              "productOffering": {
                "id": "88-1X6MRX",
                "name": "Standard GSM Discount",
                "type": "discount",
                "@baseType": null,
                "href": null,
                "@schemaLocation": null,
                "@type": "ProductOfferingRef"
              }
            }
          ]
        }
      ]
    }
  ]
}

Example of the Response Body

If successful, the response code 200 is returned with no response body.

Example 3: Purchase Order for an Atomic Offer (Single Phase Billing Fulfilment)

The following example shows how to purchase a charge offer in a single step, where an existing service object is either purchased, or a new one is created, by submitting a POST request on the REST resource using cURL. If the productCharacteristic.value against the productCharacteristic.name as Service ID exists, then it adds the offer to an existing service. Otherwise, it creates a new service with the mentioned productCharacteristic.value. For more information about cURL, see Use cURL.

Note:

The productOrderItem.product.id will be used for all subsequent actions, including suspending, resuming, and terminating the services.

The -d option specifies the file to attach as the request body. 

curl -X POST 'http://host:port/brm/orderBillFulfillment/v1/createFulfillBilling' -d @singlePhaseAtomicCharge.json

Example of the Request Body

The following is an example of the contents of the singlePhaseAtomicCharge.json file sent as the request body.

  • Add the purchased product for a Standard GSM Telephony Atomic Charge Bundle in a single step

  • Set the purchase order's start date to November 12, 2024

{
    "billingAccount": {
        "id": "0.0.0.1-329318",
        "accountNumber": "0.0.0.1-136560",
        "name": "accountName1",
        "@type": "value type"
    },
    "productOrderItem": [
        {
            "id": "88-1X6MRX",
            "action": "add",
            "@type": "ProductOrderItem",
            "requestedStartDate": "2024-11-12T00:00:00.000Z",
            "productOffering": {
                "id": "88-1X6RX",
                "name": "Standard GSM Telephony",
                "type": "charge",
                "@baseType": null,
                "href": null,
                "@schemaLocation": null,
                "@type": "ProductOfferingRef"
            },
            "product": {
                "id": "88-1XRX",
                "productCharacteristic": [
                    {
                        "@type": "CharacteristicOracle",
                        "name": "Service ID",
                        "value": "GSMTelephonyService",
                        "@baseType": null,
                        "@schemaLocation": null,
                        "unitOfMeasure": ""
                    }
                ]
           },
            "itemPrice": [
                {
          "description": "Item Price",
          "@type": "ItemPrice",
          "priceType": "/event/billing/product/fee/purchase",
          "timePeriod": {
            "startDateTime": "2024-01-21T00:00:00.000Z",
            "endDateTime": "2024-01-25T00:00:00.000Z"
          },
          "priceAlteration": [
            {
              "name": "PTPurchase1",
              "@type": "PriceAlteration",
              "priceType": "priceTag",
              "price": {
                "dutyFreeAmount": {
                  "value": 25,
                  "unit": "string"
                }
              }
            }
          ]
        },
        {
          "description": "Item Price",
          "@type": "ItemPrice",
          "priceType": "/event/billing/product/fee/purchase",
          "timePeriod": {
            "startDateTime": "2024-03-01T00:00:00.000Z",
            "endDateTime": "2024-03-31T00:00:00.000Z"
          },
          "priceAlteration": [
            {
              "name": "PTPurchase1",
              "@type": "PriceAlteration",
              "priceType": "priceTag",
              "price": {
                "dutyFreeAmount": {
                  "value": 15,
                  "unit": "string"
                }
              }
            }
          ]
        }
          ]
        }
    ]
}
For the Atomic Discount Bundle, the same payload request can be used, where
"productOrderItem": [
        {
            "id": "88-1X6MRX",
            "action": "add",
            "@type": "ProductOrderItem",
            "requestedStartDate": "2024-11-12T00:00:00.000Z",
            "productOffering": {
                "id": "88-1X6RX",
                "name": "Standard GSM Telephony",
                "type": "charge",
can be replaced with 
"productOrderItem": [
        {
            "id": "88-1X6MRX",
            "action": "add",
            "@type": "ProductOrderItem",
            "requestedStartDate": "2024-11-12T00:00:00.000Z",
            "productOffering": {
                "id": "88-1X6RX",
                "name": "Standard GSM Telephony",
                "type": "discount",

Example of the Response Body

If successful, the response code 200 is returned with no response body.

Example 4: Suspend the Associated Service for the Atomic Charge Offer

The following example shows how to suspend the purchase order of an atomic charge by submitting a POST request on the REST resource using cURL. For more information about cURL, see Use cURL.

The -d option specifies the file to attach as the request body. 

curl -X POST 'http://host:port/brm/orderBillFulfillment/v1/createFulfillBilling' -d @suspendAtomicCharge.json

Example of the Request Body

The following is an example of the contents of the suspendAtomicCharge.json file sent as the request body.

  • Suspend the purchase order for a Standard GSM Telephony Atomic Charge Bundle

  • Set the purchase order's start date to November 12, 2024

{
    "billingAccount": {
        "id": "0.0.0.1-329318",
        "accountNumber": "0.0.0.1-136560",
        "name": "accountName1",
        "@type": "value type"
    },
    "productOrderItem": [
        {
            "id": "88-1X6MRX",
            "action": "suspend",
            "@type": "ProductOrderItem",
            "requestedStartDate": "2024-11-12T00:00:00.000Z",
            "productOffering": {
                "id": "88-1X6RX",
                "name": "Standard GSM Telephony",
                "type": "charge",
                "@baseType": null,
                "href": null,
                "@schemaLocation": null,
                "@type": "ProductOfferingRef"
            },
            "product": {
                "id": "88-1XRX",
                "productCharacteristic": [
                    {
                        "@type": "CharacteristicOracle",
                        "name": "Service ID",
                        "value": "GSMTelephonyService",
                        "@baseType": null,
                        "@schemaLocation": null,
                        "unitOfMeasure": ""
                    }
                ]
           }
        }
    ]
}
For the Atomic Discount Bundle, the same payload request can be used, where
"productOrderItem": [
        {
            "id": "88-1X6MRX",
            "action": "suspend",
            "@type": "ProductOrderItem",
            "requestedStartDate": "2024-11-12T00:00:00.000Z",
            "productOffering": {
                "id": "88-1X6RX",
                "name": "Standard GSM Telephony",
                "type": "charge",
can be replaced with 
"productOrderItem": [
        {
            "id": "88-1X6MRX",
            "action": "suspend",
            "@type": "ProductOrderItem",
            "requestedStartDate": "2024-11-12T00:00:00.000Z",
            "productOffering": {
                "id": "88-1X6RX",
                "name": "Standard GSM Telephony",
                "type": "discount",

Example of the Response Body

If successful, the response code 200 is returned with no response body.

Example 5: Resume the Associated Service for the Atomic Charge Offer

The following example shows how to resume a suspended purchase order of an atomic charge by submitting a POST request on the REST resource using cURL. For more information about cURL, see Use cURL.

The -d option specifies the file to attach as the request body. 

curl -X POST 'http://host:port/brm/orderBillFulfillment/v1/createFulfillBilling' -d @resumeAtomicCharge.json

Example of the Request Body

The following is an example of the contents of the resumeAtomicCharge.json file sent as the request body.

  • Resume the suspended purchase order for a Standard GSM Telephony Atomic Charge Bundle

  • Set the purchase order's start date to November 12, 2024

{
    "billingAccount": {
        "id": "0.0.0.1-329318",
        "accountNumber": "0.0.0.1-136560",
        "name": "accountName1",
        "@type": "value type"
    },
    "productOrderItem": [
        {
            "id": "88-1X6MRX",
            "action": "resume",
            "@type": "ProductOrderItem",
            "requestedStartDate": "2024-11-12T00:00:00.000Z",
            "productOffering": {
                "id": "88-1X6RX",
                "name": "Standard GSM Telephony",
                "type": "charge",
                "@baseType": null,
                "href": null,
                "@schemaLocation": null,
                "@type": "ProductOfferingRef"
            },
            "product": {
                "id": "88-1XRX",
                "productCharacteristic": [
                    {
                        "@type": "CharacteristicOracle",
                        "name": "Service ID",
                        "value": "GSMTelephonyService",
                        "@baseType": null,
                        "@schemaLocation": null,
                        "unitOfMeasure": ""
                    }
                ]
           }
        }
    ]
}
For the Atomic Discount Bundle, the same payload request can be used, where
"productOrderItem": [
        {
            "id": "88-1X6MRX",
            "action": "resume",
            "@type": "ProductOrderItem",
            "requestedStartDate": "2024-11-12T00:00:00.000Z",
            "productOffering": {
                "id": "88-1X6RX",
                "name": "Standard GSM Telephony",
                "type": "charge",
can be replaced with 
"productOrderItem": [
        {
            "id": "88-1X6MRX",
            "action": "resume",
            "@type": "ProductOrderItem",
            "requestedStartDate": "2024-11-12T00:00:00.000Z",
            "productOffering": {
                "id": "88-1X6RX",
                "name": "Standard GSM Telephony",
                "type": "discount",

Example of the Response Body

If successful, the response code 200 is returned with no response body.

Example 6: Terminate a Purchased Product of an Atomic Charge

The following example shows how to terminate a purchased product of an atomic charge service by submitting a POST request on the REST resource using cURL. For more information about cURL, see Use cURL.

The -d option specifies the file to attach as the request body. 

curl -X POST 'http://host:port/brm/orderBillFulfillment/v1/createFulfillBilling' -d @terminateAtomicCharge.json

Example of Request Body

The following is an example of the contents of the terminateAtomicCharge.json file sent as the request body.

  • Terminate the purchase order for a Standard GSM Telephony Atomic Charge Bundle

  • Set the purchase order's completion date to November 12, 2024

{
    "billingAccount": {
        "id": "0.0.0.1-329318",
        "accountNumber": "0.0.0.1-136560",
        "name": "accountName1",
        "@type": "value type"
    },
    "productOrderItem": [
        {
            "id": "88-1X6MRX",
            "action": "terminate",
            "@type": "ProductOrderItem",
            "requestedCompletionDate": "2024-11-12T00:00:00.000Z",
            "productOffering": {
                "id": "88-1X6RX",
                "name": "Standard GSM Telephony",
                "type": "charge",
                "@baseType": null,
                "href": null,
                "@schemaLocation": null,
                "@type": "ProductOfferingRef"
            },
            "product": {
                "id": "88-1XRX",
                "productCharacteristic": [
                    {
                        "@type": "CharacteristicOracle",
                        "name": "Service ID",
                        "value": "GSMTelephonyService",
                        "@baseType": null,
                        "@schemaLocation": null,
                        "unitOfMeasure": ""
                    }
                ]
           }
        }
    ]
}
For the Atomic Discount Bundle, the same payload request can be used, where
"productOrderItem": [
        {
            "id": "88-1X6MRX",
            "action": "terminate",
            "@type": "ProductOrderItem",
            "requestedCompletionDate": "2024-11-12T00:00:00.000Z",
            "productOffering": {
                "id": "88-1X6RX",
                "name": "Standard GSM Telephony",
                "type": "charge",
can be replaced with 
"productOrderItem": [
        {
            "id": "88-1X6MRX",
            "action": "terminate",
            "@type": "ProductOrderItem",
            "requestedCompletionDate": "2024-11-12T00:00:00.000Z",
            "productOffering": {
                "id": "88-1X6RX",
                "name": "Standard GSM Telephony",
                "type": "discount",

Example of the Response Body

If successful, the response code 200 is returned with no response body.

Back to Top