> For the complete documentation index, see [llms.txt](https://docs.bunny.com/developer/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.bunny.com/developer/api-reference/types/subscriptionattributes.md). # SubscriptionAttributes ```json { "accountId": "456123", "accountCode": "", "account": { "code": "", "accountTypeId": "456123", "industryId": "456123", "employees": 123, "annualRevenue": 123, "name": "", "billingStreet": "", "billingCity": "", "billingState": "", "billingZip": "", "billingCountry": "", "billingContactId": "456123", "billingContact": { "code": "", "firstName": "", "lastName": "", "email": "", "salutation": "", "title": "", "phone": "", "mobile": "", "mailingStreet": "", "mailingCity": "", "mailingZip": "", "mailingState": "", "mailingCountry": "", "portalAccess": true, "description": "", "accountId": "456123", "accountCode": "", "campaignCode": "", "linkedinUrl": "" }, "shippingStreet": "", "shippingCity": "", "shippingState": "", "shippingZip": "", "shippingCountry": "", "description": "", "phone": "", "fax": "", "website": "", "currencyId": "456123", "taxNumber": "", "groupId": "456123", "netPaymentDays": 123, "draftInvoices": true, "newQuoteBuilder": true, "duns": "", "timezone": "", "ownerUserId": "456123", "ipAddress": "", "entityUseCode": "", "linkedinUrl": "", "invoiceTemplateId": "456123", "entityId": "456123", "secondaryBillingContactIds": [ "456123" ], "emailsEnabled": true, "disableDunning": true, "consolidatedBilling": true, "parentAccountId": "456123", "invoicedAccountId": "456123", "payingAccountId": "456123" }, "priceListCode": "", "priceListId": "456123", "priceListCharges": [ { "id": "456123", "name": "", "code": "", "priceListChargeId": "456123", "quantity": 123, "discount": "1.00", "price": "BigDecimal", "subtotal": "BigDecimal", "startDate": "2022-06-01", "endDate": "2022-06-01", "evergreen": true, "priceTiers": [ { "starts": 123, "price": "BigDecimal" } ] } ], "discounts": [ { "id": "456123", "name": "", "code": "", "priceListChargeId": "456123", "quantity": 123, "discount": "1.00", "price": "BigDecimal", "subtotal": "BigDecimal", "startDate": "2022-06-01", "endDate": "2022-06-01", "evergreen": true, "priceTiers": [ { "starts": 123, "price": "BigDecimal" } ] } ], "platformId": "456123", "platformCode": "", "tenantCode": "", "tenantName": "", "tenant": { "name": "", "code": "", "subdomain": "", "tenantUuid": "", "accountId": "456123", "platformId": "456123", "platformCode": "", "lastLogin": "2022-06-01T00:00:00Z" }, "startDate": "2022-06-01", "endDate": "2022-06-01", "trial": true, "trialStartDate": "2022-06-01", "evergreen": true, "renewalTermMonths": 123, "priceAdjustmentTiming": "PriceAdjustmentTiming", "priceAdjustmentPercentage": "1.00", "priceAdjustmentAction": "PriceAdjustmentAction", "trialExpirationAction": "TrialExpirationAction" } ``` | Name | Type | Description | | ------------------------- | --------------------------------------------------------------------------------------- | ---------------------------------------------------------------- | | accountId | ID | The id of the company or organization that is subscribing | | accountCode | String | The code of the company or organization that is subscribing | | account | [AccountAttributes](/developer/api-reference/types/accountattributes.md) | Fields to create the company or organization that is subscribing | | priceListCode | String | The code of the plan to subscribe to | | priceListId | ID | The id of the plan to subscribe to | | priceListCharges | List ([QuoteChargeAttributes](/developer/api-reference/types/quotechargeattributes.md)) | Set custom quantity, price and discount rate for charges | | discounts | List ([QuoteChargeAttributes](/developer/api-reference/types/quotechargeattributes.md)) | Set custom discount amount for price list charges | | platformId | ID | The id of the platform to provision the subscription on | | platformCode | String | The code of the platform to provision the subscription on | | tenantCode | String | A unique code that represents the tenant in a SaaS application | | tenantName | String | The name of the tenant. Typically this is the account name | | tenant | [TenantAttributes](/developer/api-reference/types/tenantattributes.md) | Fields to create a tenant for the subscription | | startDate | ISO8601Date | Date that the subscription starts | | endDate | ISO8601Date | Date that the subscription ends | | trial | Boolean | Indicates if the subscription is a trial or immediately active | | trialStartDate | ISO8601Date | Overrides the default trial start date | | evergreen | Boolean | Indicates if the subscription should be renewed automatically | | renewalTermMonths | Int | Number of months for the renewal term | | priceAdjustmentTiming | [PriceAdjustmentTiming](/developer/api-reference/enums.md#priceadjustmenttiming) | Timing of the price adjustment | | priceAdjustmentPercentage | Float | Percentage of the price adjustment | | priceAdjustmentAction | [PriceAdjustmentAction](/developer/api-reference/enums.md#priceadjustmentaction) | Action to take when the price is adjusted | | trialExpirationAction | [TrialExpirationAction](/developer/api-reference/enums.md#trialexpirationaction) | Action to take when trial expires | --- # 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, and the optional `goal` query parameter: ``` GET https://docs.bunny.com/developer/api-reference/types/subscriptionattributes.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. 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.