Jump to

• Request
• Response
• Examples

View Credit Promotions for an Account

get

/metering/api/v1/promotions/{accountId}

Retrieve details of all ongoing credit promotions for an account.

Request

Path Parameters

• accountId: string
  Account name starts with cacct.

Query Parameters

• entitlementIds: string
  Comma separated list of service entitlement Id.
• promotionIds: string
  Comma separated list of promotion id.
• sourcepromotionIds: string
  Comma separated list of sourcePromotionId.
• subscriptionIds: string
  Comma separated list of subscription id.

Back to Top

Response

Supported Media Types

• application/vnd.com.oracle.oraclecloud.metering.promotions+json

200 Response

Success

Body ()

Root Schema : Promotions

Type: object

Title: Promotions

Show Source

• canonicalLink(optional): string
• items(optional): array items

{
    "type":"object",
    "title":"Promotions",
    "properties":{
        "items":{
            "description":"",
            "type":"array",
            "items":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/json_Promotion"
                }
            }
        },
        "canonicalLink":{
            "description":"",
            "type":"string"
        }
    },
    "description":""
}

Nested Schema : items

Type: array

Show Source

• Array of: array items

{
    "description":"",
    "type":"array",
    "items":{
        "type":"array",
        "items":{
            "$ref":"#/definitions/json_Promotion"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object Promotion
  Title: Promotion

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/json_Promotion"
    }
}

Nested Schema : Promotion

Type: object

Title: Promotion

Show Source

• accountName(optional): string
• amount(optional): number
• balance(optional): number
• balanceModifiedOn(optional): object balanceModifiedOn
• balanceUnit(optional): string
• canonicalLink(optional): string
• createdOn(optional): object createdOn
• currencyUnit(optional): string
• description(optional): string
• duration(optional): string
• durationUnit(optional): string
• endDate(optional): object endDate
• entitlementIds(optional): array entitlementIds
• estimatedBalance(optional): number
• estimatedBalanceUpdatedOn(optional): object estimatedBalanceUpdatedOn
• id(optional): number
• modifiedOn(optional): object modifiedOn
• sourcePromotionId(optional): number
• startDate(optional): object startDate
• status(optional): string
• subscriptionIds(optional): array subscriptionIds

{
    "type":"object",
    "title":"Promotion",
    "properties":{
        "canonicalLink":{
            "description":"",
            "type":"string"
        },
        "id":{
            "description":"",
            "type":"number"
        },
        "sourcePromotionId":{
            "description":"",
            "type":"number"
        },
        "amount":{
            "description":"",
            "type":"number"
        },
        "duration":{
            "description":"",
            "type":"string"
        },
        "currencyUnit":{
            "description":"",
            "type":"string"
        },
        "durationUnit":{
            "description":"",
            "type":"string"
        },
        "balanceUnit":{
            "description":"",
            "type":"string"
        },
        "description":{
            "description":"",
            "type":"string"
        },
        "balance":{
            "description":"",
            "type":"number"
        },
        "balanceModifiedOn":{
            "description":"",
            "type":"object"
        },
        "startDate":{
            "description":"",
            "type":"object"
        },
        "endDate":{
            "description":"",
            "type":"object"
        },
        "createdOn":{
            "description":"",
            "type":"object"
        },
        "modifiedOn":{
            "description":"",
            "type":"object"
        },
        "estimatedBalance":{
            "description":"",
            "type":"number"
        },
        "estimatedBalanceUpdatedOn":{
            "description":"",
            "type":"object"
        },
        "accountName":{
            "description":"",
            "type":"string"
        },
        "status":{
            "description":"",
            "type":"string"
        },
        "entitlementIds":{
            "description":"",
            "type":"array",
            "items":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        },
        "subscriptionIds":{
            "description":"",
            "type":"array",
            "items":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        }
    },
    "description":""
}

Nested Schema : balanceModifiedOn

Type: object

Nested Schema : createdOn

Type: object

Nested Schema : endDate

Type: object

Nested Schema : entitlementIds

Type: array

Show Source

• Array of: array items

{
    "description":"",
    "type":"array",
    "items":{
        "type":"array",
        "items":{
            "type":"string"
        }
    }
}

Nested Schema : estimatedBalanceUpdatedOn

Type: object

Nested Schema : modifiedOn

Type: object

Nested Schema : startDate

Type: object

Nested Schema : subscriptionIds

Type: array

Show Source

• Array of: array items

{
    "description":"",
    "type":"array",
    "items":{
        "type":"array",
        "items":{
            "type":"string"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Default Response

Unexpected error.

Back to Top

Examples

These APIs are deprecated. See Cost Analysis Overview, Using the API for more information on how to track and optimize your Oracle Cloud Infrastructure spending. See the Deprecated Notices (Endpoints) to see if there is a replacement endpoint.

Back to Top