Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-141716091.1 KB

Retrieves detailed information about a specific benefit allocation that has been granted to a partner.

post/#X-Amz-Target=PartnerCentralBenefitsService.GetBenefitAllocation

Headers

X-Amz-Target'PartnerCentralBenefitsService.GetBenefitAllocation' required

Request body

Catalogstring required

The catalog identifier that specifies which benefit catalog to query.

Identifierstring required

The unique identifier of the benefit allocation to retrieve.

Response

Success

Idstring

The unique identifier of the benefit allocation.

Catalogstring

The catalog identifier that the benefit allocation belongs to.

Arnstring

The Amazon Resource Name (ARN) of the benefit allocation.

Namestring

The human-readable name of the benefit allocation.

Descriptionstring

A detailed description of the benefit allocation.

Status'ACTIVE' | 'INACTIVE' | 'FULFILLED'

The current status of the benefit allocation (e.g., active, expired, consumed).

StatusReasonstring

Additional information explaining the current status of the benefit allocation.

BenefitApplicationIdstring

The identifier of the benefit application that resulted in this allocation.

BenefitIdstring

The identifier of the benefit that this allocation is based on.

FulfillmentType'CREDITS' | 'CASH' | 'ACCESS'

The fulfillment type used for this benefit allocation.

ApplicableBenefitIdsBenefitId[]

A list of benefit identifiers that this allocation can be applied to.

CreatedAtstring date-time

The timestamp when the benefit allocation was created.

UpdatedAtstring date-time

The timestamp when the benefit allocation was last updated.

StartsAtstring date-time

The timestamp when the benefit allocation becomes active and usable.

ExpiresAtstring date-time

The timestamp when the benefit allocation expires and is no longer usable.