---
title: "Subscription object"
url: "https://help.internetx.com/en/api/core-subscription-object/"
lang: "en"
section: "API reference — API reference (XML/JSON)"
breadcrumb: "API documentation (JSON/XML) > Objects"
updated: "2023-10-12"
---

# Subscription object

## Description

The _Subscription_ object represents a subscription.

## Structure

| **Keyword JSON** | **Keyword XML** | **Occurs** | **Type** | **Format** | **Description** |
| --- | --- | --- | --- | --- | --- |
| created | created | 1 | string | date-time | Date of creation. |
| updated | updated | 1 | string | date-time | Date of the last update. |
| owner | owner | 1 | object | [BasicUser](/en/api/core-basic-user-object/) | The object owner. |
| updater | updater | 1 | object | [BasicUser](/en/api/core-basic-user-object/) | User who last updated the subscription. |
|  | billing | 1 | object | [BasicUser](/en/api/core-basic-user-object/) | User who receives the invoice. |
| status | status | 1 | enum | [BillingStatus](/en/api/core-billing-status-enum/) | Billing status of the subscription. |
| object | object | 1 | string |  | Name of the subscription or the contract number. |
|  | description | 1 | string |  | Subscription name. |
| articleTypeLabel | article\_type\_label | 1 | string |  | The article type label of the subscription, e.g. domain. |
| items | item | 0 - n | string |  | The items of the subscription. |
| expire | expire | 1 | string | date-time | The expiration date of the subscription. |
| cancelation | cancelation | 1 | string | date-time | The cancelation date of the subscription. |
| businessCase | identifier | 1 | string |  | The business case of the subscription, e.g. "create". |
|  | renew\_period | 1 | object | [TimePeriod](/de/api/core-objekt-timeperiod/) | Specifies by how many years, months, weeks, or days the extension of the current subscription will be. |
|  | cancelation\_term\_expire\_only | 1 | boolean |  | Flag whether it is possible to cancel only on the expiration date of the subscription.<br>Possible values:<br>• false = Anytime<br>• true = Only at expiration date<br>Default value = true<br>For XML also 0 (false) and 1 (true) can be used. |
|  | cancelation\_term | 1 | object | [TimePeriod](/de/api/core-objekt-timeperiod/) | Termination period before the next payment is due. |
|  | count | 1 | integer | int32 | Number of objects included in the subscription. |
| payable | payable | 1 | string | date-time | The next payment date for the subscription. |
| id | id | 1 | integer | int64 | Unique identification number for this subscription. |
| period | period | 1 | object | [TimePeriod](/de/api/core-objekt-timeperiod/) | The period used by the subscription, e.g. 1 month. |
|  | customer | 1 | object | [BasicCustomer](/de/api/core-objekt-basic-customer/) | Subscription customer. |
| extensions | ext | 0 - 1 | object | BillingEventExtensions | Additional information, such as rights and limits. |