Learn how to retrieve a specific invoice group configuration by using the Settings API.

Use this operation to view how subscription charges and order line items (OLIs) are grouped into invoices and credit memos as part of Configurable Invoice Grouping.

To get a specific invoice group, the ID or number of the invoice group is required as a path parameter. For example, {api_url}/settings/invoice-groups/IG-00000001

See the following request and a sample of a 200 response.

HTTP request:

GET {api_url}/settings/invoice-groups/{id | number}

Response body:

{
  "id": "2c92c0f977123456017712f9e6a00001",
  "number": "IG-00000001",
  "name": "My Global Group",
  "meta": {
    "subscriptionGroup": [
      {
        "objectType": "Subscription",
        "field": "TransactionType__c"
      },
      {
        "objectType": "Subscription",
        "field": "SoldToContactId"
      },
      {
        "objectType": "RatePlanCharge",
        "field": "TransactionType__c"
      },
      {
        "objectType": "RatePlanCharge",
        "field": "ChargeType"
      }
    ],
    "orderLineItemGroup": [
      {
        "objectType": "OrderLineItem",
        "field": "TransactionType__c"
      },
      {
        "objectType": "OrderLineItem",
        "field": "SoldTo"
      }
    ]
  }
}