> ## Documentation Index
> Fetch the complete documentation index at: https://docs.bango.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Consumer Offer

> Schema and fields for the Consumer Offer resource

A Consumer Offer represents an Offer that has been provisioned for a specific consumer. It links the Offer to the consumer and tracks status, sub-status, and a timeline of events.

## Attributes

### consumerOfferId

Identifier for the consumer offer (UUID).

***

### offerId

Offer identifier (UUID).

***

### consumer

The consumer associated with this offer. Contains:

* **consumerIdentifier** — Identity of the consumer
* **communicationInformation** — Optional; emailAddress, msisdn

***

### status

The status of the consumer offer.

| Value | Description |
| - | - |
| `REQUESTED` | Provisioning has been requested and is pending. |
| `CREATES_FAILED` | One or more create operations failed. |
| `FULLY_CREATED` | All components (e.g. entitlements, billing) have been created. |
| `PARTIALLY_CREATED` | Some but not all components have been created. |
| `FULLY_ACTIVE` | The consumer offer is active and in use. |
| `FULLY_TERMINATED` | The consumer offer has been fully terminated. |

***

### subStatus

The sub-status of the consumer offer.

| Value | Description |
| - | - |
| `PENDING_CREATES` | Create operations are in progress or queued. |
| `PENDING_ACTIVATES` | Activation is pending for one or more entitlements. |
| `PENDING_TERMINATES` | Termination has been requested and is in progress. |

***

### timeline

Timeline of changes made to the consumer offer. Contains (each ISO 8601 date-time when present):

* **createRequestedTs** — When creation of the offer was requested
* **createdTs** — When the offer was created
* **createsFailedTs** — When creation failed (if applicable)
* **entitlementsRequestedTs** — When entitlements for the offer were requested
* **terminateRequestedTs** — When termination was requested (if applicable)

***

<ResponseExample>
  ```json Consumer Offer theme={null}
  {
    "consumerOfferId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "offerId": "f58ecec5-27cc-40c8-8723-4d01678fed6f",
    "consumer": {
      "consumerIdentifier": "user-123",
      "communicationInformation": {
        "emailAddress": "consumer@example.com",
        "msisdn": "+441234567890"
      }
    },
    "status": "FULLY_ACTIVE",
    "subStatus": "PENDING_ACTIVATES",
    "timeline": {
      "createRequestedTs": "2024-06-22T10:00:00.000Z",
      "createdTs": "2024-06-22T10:00:05.000Z",
      "entitlementsRequestedTs": "2024-06-22T10:00:06.000Z"
    }
  }
  ```
</ResponseExample>