Usage Product Activation (POST)

Activate a usage product and its related records, such as usage resources, grants, policies, and rate card entries, in a single request.

Keep these considerations in mind when you use this API.

  • In version 67.0, each request activates one product. If a request includes more than one product, the API returns the MAX_LIMIT_EXCEEDED error.
  • Each record in the request stays in Draft status until activation runs. If any record for the product fails to activate, the API rolls back all activations for that product.
  • The records activate in the order required by their dependencies, so a child record never activates before its parent.
  • Each request activates a maximum of 200 records, including the product and all of its associated child records. If the request exceeds 200 records, the API returns the MAX_LIMIT_EXCEEDED error.

Resource 

1/revenue/usage-management/usage-products/actions/activate

Resource Example 

1https://{yourInstance}.salesforce.com/services/data/v68.0/revenue/usage-management/usage-products/actions/activate

Available Version 

67.0

HTTP Methods 

POST

Request Body for POST 

JSON Example

1{
2  "shouldValidateProductSetup": false,
3  "activationRequests": [
4    {
5      "productId": "01txx0000006i2gAAA",
6      "usageResourceIds": [
7        "0hUxx000000001",
8        "0hUxx000000002"
9      ]
10    }
11  ]
12}

Properties

NameTypeDescriptionRequired or OptionalAvailable Version
activation​RequestsUsage Activation Request Input[]List of activation requests. Each entry identifies a product and the usage resources to activate for that product. This list accepts only one entry. If you include more, the API returns the MAX_LIMIT_EXCEEDED error.Required67.0
shouldValidate​ProductSetupBooleanIndicates whether to run product setup validation before activation (true) or not (false). The default value is true.Optional67.0

Response Body for POST 

Usage Product Activation