> For the complete documentation index, see [llms.txt](https://apidocs.akinon.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://apidocs.akinon.com/commerce-openapis/subscription/models.md).

# Models

## The SubscriptionSchemaResponse object

```json
{"openapi":"3.0.0","info":{"title":"Subscriptions API","version":"1.0.0"},"components":{"schemas":{"SubscriptionSchemaResponse":{"type":"object","description":"Response containing the subscription form schema configuration","required":["attributes"],"properties":{"attributes":{"type":"object","description":"Dynamic schema object where each key represents an attribute name\nand the value contains the attribute configuration including type,\nvalidation rules, and display properties.\n","additionalProperties":{"$ref":"#/components/schemas/AttributeSchema"}}}},"AttributeSchema":{"type":"object","description":"Configuration for a single subscription form attribute","properties":{"label":{"type":"string","description":"Display label for the attribute"},"data_type":{"type":"string","description":"The data type of the attribute. Common types include text, number,\nemail, dropdown, checkbox, date, and nested_object.\n","enum":["text","number","email","dropdown","checkbox","date","nested_object"]},"is_required":{"type":"boolean","description":"Indicates whether this attribute must be provided when creating\na subscription.\n","default":false},"multi":{"type":"boolean","description":"Indicates whether this attribute accepts multiple values (array)\nor a single value.\n","default":false},"is_localizable":{"type":"boolean","description":"Indicates whether this attribute supports multiple language\ntranslations.\n","default":false},"choices":{"type":"array","description":"Available options for dropdown-type attributes. Only applicable\nwhen data_type is 'dropdown'.\n","items":{"type":"object","properties":{"value":{"type":"string","description":"The option value"},"label":{"type":"string","description":"The display label for the option"}}}},"schema":{"type":"object","description":"Nested schema definition for nested_object-type attributes.\nOnly applicable when data_type is 'nested_object'.\n","additionalProperties":{"$ref":"#/components/schemas/AttributeSchema"}}}}}}}
```

## The AttributeSchema object

```json
{"openapi":"3.0.0","info":{"title":"Subscriptions API","version":"1.0.0"},"components":{"schemas":{"AttributeSchema":{"type":"object","description":"Configuration for a single subscription form attribute","properties":{"label":{"type":"string","description":"Display label for the attribute"},"data_type":{"type":"string","description":"The data type of the attribute. Common types include text, number,\nemail, dropdown, checkbox, date, and nested_object.\n","enum":["text","number","email","dropdown","checkbox","date","nested_object"]},"is_required":{"type":"boolean","description":"Indicates whether this attribute must be provided when creating\na subscription.\n","default":false},"multi":{"type":"boolean","description":"Indicates whether this attribute accepts multiple values (array)\nor a single value.\n","default":false},"is_localizable":{"type":"boolean","description":"Indicates whether this attribute supports multiple language\ntranslations.\n","default":false},"choices":{"type":"array","description":"Available options for dropdown-type attributes. Only applicable\nwhen data_type is 'dropdown'.\n","items":{"type":"object","properties":{"value":{"type":"string","description":"The option value"},"label":{"type":"string","description":"The display label for the option"}}}},"schema":{"type":"object","description":"Nested schema definition for nested_object-type attributes.\nOnly applicable when data_type is 'nested_object'.\n","additionalProperties":{"$ref":"#/components/schemas/AttributeSchema"}}}}}}}
```

## The SubscriptionRequest object

```json
{"openapi":"3.0.0","info":{"title":"Subscriptions API","version":"1.0.0"},"components":{"schemas":{"SubscriptionRequest":{"type":"object","description":"Request payload for creating a new subscription","required":["email"],"properties":{"email":{"type":"string","format":"email","description":"The email address for the subscription. Must be unique across\nall subscriptions.\n"},"attributes":{"type":"object","description":"Additional subscription attributes as defined by the subscription\nform schema. The structure and required fields depend on the\ncurrent schema configuration retrieved from the GET endpoint.\n","additionalProperties":true}}}}}}
```

## The SubscriptionResponse object

```json
{"openapi":"3.0.0","info":{"title":"Subscriptions API","version":"1.0.0"},"components":{"schemas":{"SubscriptionResponse":{"type":"object","description":"Response containing the created subscription details","properties":{"pk":{"type":"integer","description":"Unique identifier for the subscription","readOnly":true},"email":{"type":"string","format":"email","description":"The subscription email address"},"attributes":{"type":"object","description":"The subscription attributes as stored. This includes all provided\nattributes with their processed values.\n","additionalProperties":true},"attributes_kwargs":{"type":"object","description":"Additional metadata and configuration for each attribute, including\ndata type information and translation data where applicable.\n","additionalProperties":true,"readOnly":true},"is_sync":{"type":"boolean","description":"Indicates whether the subscription has been synchronized with\nexternal systems.\n","default":false},"created_date":{"type":"string","format":"date-time","description":"Timestamp when the subscription was created","readOnly":true},"modified_date":{"type":"string","format":"date-time","description":"Timestamp when the subscription was last modified","readOnly":true}}}}}}
```

## The Error object

```json
{"openapi":"3.0.0","info":{"title":"Subscriptions API","version":"1.0.0"},"components":{"schemas":{"Error":{"type":"object","description":"Standard error response","properties":{"error":{"type":"string","description":"Error message describing what went wrong"}}}}}}
```

## The ValidationError object

```json
{"openapi":"3.0.0","info":{"title":"Subscriptions API","version":"1.0.0"},"components":{"schemas":{"ValidationError":{"type":"object","description":"Validation error response","properties":{"error":{"type":"string","description":"General validation error message"}},"additionalProperties":{"type":"array","items":{"type":"string"},"description":"Field-specific validation errors"}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://apidocs.akinon.com/commerce-openapis/subscription/models.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.