# Get the subscription estimate

Get an estimate of the upcoming subscription based on current usage

Endpoint: GET /subscription-estimate
Version: 2.0.0
Security: bearerToken

## Response 200 fields (application/json):

  - `result` (object, required)

  - `result.type` (string, required)
    Enum: "CREATED"

  - `result.accountId` (string, required)
    The unique ID of the Account the [Subscription](#tag/Subscription) is for
    Example: "cfb665ca-ce35-4418-b9d5-70ee815db4bd"

  - `result.startDate` (string, required)
    The datetime the [Subscription](#tag/Subscription) started in ISO datetime format
    Example: "2021-02-17T09:24:01.417Z"

  - `result.companyName` (string,null, required)
    The company name of the [Subscription](#tag/Subscription)
    Example: "Acme Inc."

  - `result.plan` (any, required)

  - `result.billing` (object, required)

  - `result.billing.name` (string, required)
    The name of the billing contact
    Example: "Example name"

  - `result.billing.email` (string, required)
    The email of the billing contact
    Example: "email@example.com"

  - `result.billing.address` (object, required)

  - `result.billing.address.country` (string, required)
    Example: "United Kingdom"

  - `result.billing.address.state` (string,null)
    Example: "Texas"

  - `result.billing.address.city` (string,null)
    Example: "Brighton"

  - `result.billing.address.postalCode` (string,null)
    Example: "BN1 1AB"

  - `result.billing.address.line1` (string, required)
    Example: "Flat 56"

  - `result.billing.address.line2` (string,null)
    Example: "13 some road"

  - `result.billing.period` (string, required)
    How frequently you want to be billed
    Enum: "MONTHLY", "QUARTERLY", "SEMIANNUALLY", "ANNUALLY", "BIENNIALLY"

  - `result.billing.currency` (string, required)
    The currency code of the currency you want to pay in
    Enum: "GBP", "EUR", "USD", "AUD", "CAD"

  - `result.billing.nextBillingDate` (string, required)
    The datetime the next invoice for the subscription will be sent
    Example: "2021-02-17T09:24:01.417Z"

  - `result.billing.amount` (object, required)

  - `result.billing.amount.amountWithTax` (integer, required)
    The price of the subscription in the lowest denomination of the chosen currency
    Example: 12000

  - `result.billing.amount.amountWithoutTax` (integer, required)
    The price of the subscription without tax in the lowest denomination of the chosen currency
    Example: 10000

  - `result.billing.amount.includesTax` (boolean, required)
    Whether the price for the subscription includes tax
    Example: true

  - `result.coupons` (array, required)

  - `result.coupons.id` (string, required)
    The ID of the coupon
    Example: "5%OFF-COUPON"

  - `result.coupons.name` (string, required)
    The name of the coupon
    Example: "5% off coupon"

  - `result.coupons.discountPercentage` (number, required)
    The percentage discount given by the coupon
    Example: 12.5

  - `result.coupons.status` (string, required)
    The status of the coupon
    Enum: "ACTIVE", "EXPIRED", "ARCHIVED", "DELETED"

  - `result.signupUser` (object, required)

  - `result.signupUser.email` (string, required)
    Email of the user who is signing up
    Example: "some@email.com"

  - `result.signupUser.name` (string,null)
    Name of the user who is signing up
    Example: "Some Name"

  - `permittedActions` (array, required)

  - `permittedActions.resourceType` (string, required)
    Defines the type of the resource that is being permitted to act on
    Enum: "ACCOUNT", "ASSET", "ASSET_SHARES", "ASSETS", "ASSETS_IN_NO_FOLDERS", "CLOUD_CONNECTION", "CLOUD_CONNECTIONS", "COLLECTION", "COLLECTIONS", "COMMENT", "CUSTOM_TERMS_AND_CONDITIONS", "EMAILS", "FIELD_OPTION", "FIELDS", "INDESIGN_EXTENSION", "INTELLIGENCE_SETTINGS", "METADATA_SCHEMA", "PORTALS", "PRESET_SIZES", "REFERRAL", "SAVED_SEARCHES", "SHOPIFY_INTEGRATION_V2", "SUBSCRIPTION", "THEME", "TOP_LEVEL_FIELD_OPTIONS", "USER_GROUPS", "WEB_USAGE"

  - `permittedActions.resourceId` (string)
    The ID of the resource that is being permitted to act on.  This may be null if the permission is on the resource type as a whole rather than an individual instance.
    Example: "7af90a8b-7ccd-430f-a85d-e8614015bc47"

  - `permittedActions.action` (string, required)
    Defines the action that is being permitted
    Enum: "ADD_ASSET_TO_COLLECTION", "ADD_COLLABORATOR_TO_COLLECTION", "APPROVE_ASSETS", "CONFIGURE_SHOPIFY_INTEGRATION", "CREATE_ASSET_SHARES", "CREATE_ASSETS", "CREATE_CHILD_FIELD_OPTIONS", "CREATE_CLOUD_CONNECTIONS", "CREATE_COLLECTIONS", "CREATE_COLLECTION_COMMENTS", "CREATE_COMMENTS", "CREATE_EMBEDDABLE_LINKS", "CREATE_PORTALS", "CREATE_SAVED_SEARCHES", "CREATE_SUBSCRIPTION", "CREATE_TOP_LEVEL_FIELD_OPTIONS", "CUSTOMISE_EMAILS", "DELETE_ASSET", "DELETE_CLOUD_CONNECTION", "DELETE_COLLECTION", "DELETE_COMMENT", "DOWNLOAD_ASSET", "DOWNLOAD_INDESIGN_EXTENSION", "EDIT_ACCOUNT", "EDIT_ASSET", "EDIT_CLOUD_CONNECTION", "EDIT_COLLECTION", "EDIT_COMMENT", "EDIT_FIELDS", "EDIT_INTELLIGENCE_SETTINGS_ADDRESS_LOOKUP", "EDIT_INTELLIGENCE_SETTINGS_IMAGE_AUTO_TAGGING", "EDIT_INTELLIGENCE_SETTINGS_IMAGE_FACIAL_REC", "EDIT_INTELLIGENCE_SETTINGS_TEXT_IN_IMAGE", "EDIT_INTELLIGENCE_SETTINGS_VIDEO_AUTO_TAGGING", "EDIT_INTELLIGENCE_SETTINGS_VIDEO_FACIAL_REC", "EDIT_METADATA_SCHEMA", "EDIT_PRESET_SIZES", "EDIT_THEME", "EDIT_USER_GROUPS", "EXPORT_TO_SHOPIFY", "IMPORT_ASSETS_OR_METADATA", "IMPORT_FROM_CLOUD", "MAKE_REFERRAL", "MANAGE_CUSTOM_TERMS_AND_CONDITIONS", "PROMOTE_ASSETS_TO_LIVE", "PUT_ASSETS_IN_NO_FOLDER", "REMOVE_ASSET_FROM_COLLECTION", "REMOVE_COLLABORATOR_FROM_COLLECTION", "RUN_NATURAL_LANGUAGE_SEARCH", "SEARCH_FOR_VIEW", "SET_ASSETS_LIFECYCLE_STATUS_BINNED", "SET_ASSETS_LIFECYCLE_STATUS_LIVE", "UPDATE_METADATA_WITH_FIELD_OPTION", "USE_CANVA_INTEGRATION", "USE_CLOUD_CONNECTION", "USE_COLLECTIONS", "USE_EMBEDDABLE_LINKS", "VIEW_ASSET", "VIEW_ASSET_EVENTS", "VIEW_ASSET_FACES", "VIEW_ASSETS_IN_NO_FOLDER", "VIEW_CLOUD_CONNECTION", "VIEW_COLLECTION", "VIEW_COMMENTS", "VIEW_WEB_USAGE"

## Response 4XX fields (application/json):

  - `timestamp` (string)
    The datetime that the error occurred in ISO offset format
    Example: "2021-02-16T16:21:58.640+00:00"

  - `status` (integer)
    The HTTP status code of the error
    Example: 401

  - `error` (string)
    The title of the error
    Example: "Unauthorized"

  - `message` (string)
    A more detailed error message

  - `path` (string)
    The path that was called which led to the error
    Example: "/folder-settings"