Skip to content

Create Custom Line Item

billingconductor_create_custom_line_item R Documentation

Creates a custom line item that can be used to create a one-time fixed charge that can be applied to a single billing group for the current or previous billing period

Description

Creates a custom line item that can be used to create a one-time fixed charge that can be applied to a single billing group for the current or previous billing period. The one-time fixed charge is either a fee or discount.

Usage

billingconductor_create_custom_line_item(ClientToken, Name, Description,
  BillingGroupArn, BillingPeriodRange, Tags, ChargeDetails, AccountId,
  ComputationRule, PresentationDetails)

Arguments

ClientToken

A unique, case-sensitive identifier that you specify to ensure idempotency of the request. Idempotency ensures that an API request completes no more than one time. With an idempotent request, if the original request completes successfully, any subsequent retries complete successfully without performing any further actions.

Name

[required] The name of the custom line item.

Description

[required] The description of the custom line item. This is shown on the Bills page in association with the charge value.

BillingGroupArn

[required] The Amazon Resource Name (ARN) that references the billing group where the custom line item applies to.

BillingPeriodRange

A time range for which the custom line item is effective.

Tags

A map that contains tag keys and tag values that are attached to a custom line item.

ChargeDetails

[required] A CustomLineItemChargeDetails that describes the charge details for a custom line item.

AccountId

The Amazon Web Services account in which this custom line item will be applied to.

ComputationRule

Specifies how the custom line item charges are computed.

PresentationDetails

Details controlling how the custom line item charges are presented in the bill. Contains specifications for which service the charges will be shown under.

Value

A list with the following syntax:

list(
  Arn = "string"
)

Request syntax

svc$create_custom_line_item(
  ClientToken = "string",
  Name = "string",
  Description = "string",
  BillingGroupArn = "string",
  BillingPeriodRange = list(
    InclusiveStartBillingPeriod = "string",
    ExclusiveEndBillingPeriod = "string"
  ),
  Tags = list(
    "string"
  ),
  ChargeDetails = list(
    Flat = list(
      ChargeValue = 123.0
    ),
    Percentage = list(
      PercentageValue = 123.0,
      AssociatedValues = list(
        "string"
      )
    ),
    Type = "CREDIT"|"FEE",
    LineItemFilters = list(
      list(
        Attribute = "LINE_ITEM_TYPE"|"SERVICE",
        MatchOption = "NOT_EQUAL"|"EQUAL",
        Values = list(
          "SAVINGS_PLAN_NEGATION"
        ),
        AttributeValues = list(
          "string"
        )
      )
    )
  ),
  AccountId = "string",
  ComputationRule = "ITEMIZED"|"CONSOLIDATED",
  PresentationDetails = list(
    Service = "string"
  )
)