openapi: 3.0.0 info: description: The Companies API allows developers to manage marketplace companies and their user memberships. title: Companies AI Embed Subscriptions API license: name: Apache License, Version 2.0 url: http://www.apache.org/licenses/LICENSE-2.0 version: v296.0-SNAPSHOT servers: - url: https://marketplace.appdirect.com/api - url: https://virtserver.swaggerhub.com tags: - name: Subscriptions x-displayName: Subscriptions paths: /account/v2/subscriptions/{subscriptionUuid}/reactivationRequest: post: description: 'Send a subscription reactivation request. This endpoint sends a notification to the subscription owner. If company-wide billing is enabled, this endpoint also sends a notification to all company administrators (Company Admin and Billing Admin).' tags: - Subscriptions summary: Subscription reactivation request operationId: resource_Subscription_requestSubscriptionReactivation_POST x-appdirect-required-scopes: ROLE_USER: - Allows access as a member of the company that owns the subscription. ROLE_CHANNEL_ADMIN: - Allows access as a Marketplace Manager for the marketplace. ROLE_CORPORATE_ADMIN: - Allows access as a Network Manager for the marketplace. parameters: - description: Unique identifier of company subscription in the API request name: subscriptionUuid in: path required: true schema: type: string responses: '200': description: Success '401': description: Unauthorized or subscription not found x-codeSamples: - lang: Shell + Curl source: "curl --request POST \\\n --url https://marketplace.appdirect.com/api/account/v2/subscriptions/%7BsubscriptionUuid%7D/reactivationRequest" - lang: Node + Request source: "const request = require('request');\n\nconst options = {\n method: 'POST',\n url: 'https://marketplace.appdirect.com/api/account/v2/subscriptions/%7BsubscriptionUuid%7D/reactivationRequest'\n};\n\nrequest(options, function (error, response, body) {\n if (error) throw new Error(error);\n\n console.log(body);\n});\n" - lang: Java + Okhttp source: "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://marketplace.appdirect.com/api/account/v2/subscriptions/%7BsubscriptionUuid%7D/reactivationRequest\")\n .post(null)\n .build();\n\nResponse response = client.newCall(request).execute();" /account/v2/subscriptions/{subscriptionUuid}/saml/certificate: get: description: Retrieve a subscriptions's public SAML verification certificate. tags: - Subscriptions summary: Read subscription SAML Certificate operationId: resource_Subscription_readSamlCertificate_GET x-appdirect-required-scopes: ROLE_USER: - Allows access as the user that owns the subscription. ROLE_BILLING_ADMIN: - Allows access as a Billing Admin of the company that owns the subscription. ROLE_CHANNEL_ADMIN: - Allows access as a Marketplace Manager for the marketplace. ROLE_CORPORATE_ADMIN: - Allows access as a Network Manager for the marketplace. ROLE_PARTNER_READ: - Allows read access to all marketplace data. ROLE_CHANNEL_PRODUCT_SUPPORT: - Allows access as a Product Support agent for the marketplace. ROLE_APPLICATION: - Allows access as the Developer that owns the Product. parameters: - description: Unique identifier of company subscription in the API request name: subscriptionUuid in: path required: true schema: type: string responses: '200': description: Success content: application/json: examples: response: value: '-----BEGIN CERTIFICATE----- MIICyDCCAbCgAwIBAgIGAWF7mAIjMA0GCSqGSIb3DQEBBQUAMCUxIzAhBgNVBAoM GkNPTVBBTllfRU5USVRMRU1FTlQtNzQ1NzI5MB4XDTE4MDIwODE3MjMzNVoXDTIz MDIwOTE3MjMzNVowJTEjMCEGA1UECgwaQ09NUEFOWV9FTlRJVExFTUVOVC03NDU3 MjkwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCQvnSC76Jwsrjw0FDO MzutqNLyrlww86LiEcDiaGn/Ms6cASbpQFJiA7f5BVbTHCAS4fPQnLcBoZs25OwP 69ibm5hrJlfmZwPVU0Odqd9M/kGmV4U4EDgieH6BcF0cXwpJ8OeXLhf8N+9tr9sN 7MvkvMgGqpjwXAwYDFZWxBf0+k6O+rO/XuCuIKtc4eD0jPIS6NfxD5DvXNGc83ro ffgjM0HNq41jieDAhmAAnj12LoRE4V3qQwqbE3p5JBHsmjOJ2/kGoZdkorf3oSuT jlsLooDi/NTKlWxnlIvnlNSBnlfzpZl6yQIW4j8FDe/4p02G6VMYIozTB37OM98j 4USHAgMBAAEwDQYJKoZIhvcNAQEFBQADggEBAHrlJjQs05EykfyuvUFZUOjAiqwN M/1WHW8xtCA/qa7H1PJQ6B7xyJcmw/ad23ui74sycfkmCLMACP1tb0M8CJ6/rsZH ltUy8sXSGg3fyTA9Ff8sJiMs0nCw0Wzkk+P5JGig7kPBi1W7gSFTP4tfrktp65sU xefLNh/axCHE2C5lxrYtwsE8ocSqNZwPDIWihcaapvdxDyr8l62F2dL3NXulLVRW OV4G+KGVwCCEswjTN3idyGjknBCgaiFmKMPFeZm5feUE6f2D40Z/CLrcaB1HV5/q MBljuA6qKsDLaABwtxvviQ18p2GYmfpXv5mLJlSNSRnzH9zQzjGsqV09x7U= -----END CERTIFICATE----- ' '401': description: Unauthorized '500': description: Subscription not found x-codeSamples: - lang: Shell + Curl source: "curl --request GET \\\n --url https://marketplace.appdirect.com/api/account/v2/subscriptions/%7BsubscriptionUuid%7D/saml/certificate" - lang: Node + Request source: "const request = require('request');\n\nconst options = {\n method: 'GET',\n url: 'https://marketplace.appdirect.com/api/account/v2/subscriptions/%7BsubscriptionUuid%7D/saml/certificate'\n};\n\nrequest(options, function (error, response, body) {\n if (error) throw new Error(error);\n\n console.log(body);\n});\n" - lang: Java + Okhttp source: "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://marketplace.appdirect.com/api/account/v2/subscriptions/%7BsubscriptionUuid%7D/saml/certificate\")\n .get()\n .build();\n\nResponse response = client.newCall(request).execute();" /account/v2/subscriptions/{subscriptionUuid}/saml: get: description: Retrieve a subscription's SAML metadata. tags: - Subscriptions summary: Read SAML metadata for subscription operationId: resource_Subscription_readSamlInfo_GET x-appdirect-required-scopes: ROLE_USER: - Allows access as the user that owns the subscription. ROLE_BILLING_ADMIN: - Allows access as a Billing Admin of the company that owns the subscription. ROLE_CHANNEL_ADMIN: - Allows access as a Marketplace Manager for the marketplace. ROLE_CORPORATE_ADMIN: - Allows access as a Network Manager for the marketplace. ROLE_PARTNER_READ: - Allows read access to all marketplace data. ROLE_CHANNEL_PRODUCT_SUPPORT: - Allows access as a Product Support agent for the marketplace. ROLE_APPLICATION: - Allows access as the Developer that owns the Product. parameters: - description: Unique identifier of company subscription in the API request name: subscriptionUuid in: path required: true schema: type: string responses: '200': description: Success content: application/json: examples: response: value: version: '2.0' uuid: 8ae5c488-9d5b-4867-a944-78b6afbb9c82 idpIdentifier: https://test.marketplace.com/saml/8ae5c488-9d5b-4867-a944-78b6afbb9c82 assertionConsumerServiceUrl: https://www.example.com/saml/acs spLaunchUrl: https://www.example.com/saml/login audienceUrl: https://www.example.com loginUrl: https://test.marketplace.com/saml/idp/login/8ae5c488-9d5b-4867-a944-78b6afbb9c82 relayState: null nameIdType: urn:oasis:names:tc:SAML:2.0:nameid-format:persistent nameId: '{user.uuid}' notBeforeMinutes: 5 notAfterMinutes: 5 attributes: FirstName: name: FirstName type: '{http://www.w3.org/2001/XMLSchema}string' value: '{user.firstName}' Email: name: Email type: '{http://www.w3.org/2001/XMLSchema}string' value: '{user.emailAddress}' LastName: name: LastName type: '{http://www.w3.org/2001/XMLSchema}string' value: '{user.lastName}' certificate: uuid: 6bd1d10c-ddb8-4908-a5a7-0e918f28a2ae publicCertificate: '-----BEGIN CERTIFICATE----- MIICyDCCAbCgAwIBAgIGAWF7mAIjMA0GCSqGSIb3DQEBBQUAMCUxIzAhBgNVBAoM GkNPTVBBTllfRU5USVRMRU1FTlQtNzQ1NzI5MB4XDTE4MDIwODE3MjMzNVoXDTIz MDIwOTE3MjMzNVowJTEjMCEGA1UECgwaQ09NUEFOWV9FTlRJVExFTUVOVC03NDU3 MjkwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCQvnSC76Jwsrjw0FDO MzutqNLyrlww86LiEcDiaGn/Ms6cASbpQFJiA7f5BVbTHCAS4fPQnLcBoZs25OwP 69ibm5hrJlfmZwPVU0Odqd9M/kGmV4U4EDgieH6BcF0cXwpJ8OeXLhf8N+9tr9sN 7MvkvMgGqpjwXAwYDFZWxBf0+k6O+rO/XuCuIKtc4eD0jPIS6NfxD5DvXNGc83ro ffgjM0HNq41jieDAhmAAnj12LoRE4V3qQwqbE3p5JBHsmjOJ2/kGoZdkorf3oSuT jlsLooDi/NTKlWxnlIvnlNSBnlfzpZl6yQIW4j8FDe/4p02G6VMYIozTB37OM98j 4USHAgMBAAEwDQYJKoZIhvcNAQEFBQADggEBAHrlJjQs05EykfyuvUFZUOjAiqwN M/1WHW8xtCA/qa7H1PJQ6B7xyJcmw/ad23ui74sycfkmCLMACP1tb0M8CJ6/rsZH ltUy8sXSGg3fyTA9Ff8sJiMs0nCw0Wzkk+P5JGig7kPBi1W7gSFTP4tfrktp65sU xefLNh/axCHE2C5lxrYtwsE8ocSqNZwPDIWihcaapvdxDyr8l62F2dL3NXulLVRW OV4G+KGVwCCEswjTN3idyGjknBCgaiFmKMPFeZm5feUE6f2D40Z/CLrcaB1HV5/q MBljuA6qKsDLaABwtxvviQ18p2GYmfpXv5mLJlSNSRnzH9zQzjGsqV09x7U= -----END CERTIFICATE----- ' publicKey: '-----BEGIN PUBLIC KEY----- MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAkL50gu+icLK48NBQzjM7 rajS8q5cMPOi4hHA4mhp/zLOnAEm6UBSYgO3+QVW0xwgEuHz0Jy3AaGbNuTsD+vY m5uYayZX5mcD1VNDnanfTP5BpleFOBA4Inh+gXBdHF8KSfDnly4X/Dfvba/bDezL 5LzIBqqY8FwMGAxWVsQX9PpOjvqzv17griCrXOHg9IzyEujX8Q+Q71zRnPN66H34 IzNBzauNY4ngwIZgAJ49di6EROFd6kMKmxN6eSQR7Jozidv5BqGXZKK396Erk45b C6KA4vzUypVsZ5SL55TUgZ5X86WZeskCFuI/BQ3v+KdNhulTGCKM0wd+zjPfI+FE hwIDAQAB -----END PUBLIC KEY----- ' fingerprint: 6D:44:10:BF:DD:D6:B9:46:ED:CB:05:B6:96:C4:07:5E:02:C0:27:E6 expirationDate: 1676872384000 partner: APPDIRECT label: AD Cert defaultCertificate: true subjectDN: O=COMPANY_ENTITLEMENT-1893 keySize: 2048 needsRenewal: false certificateUsage: PER_RELYING_PARTY encodeResponse: true responseParameterName: SAMLResponse signingSource: RESPONSE signingAlgorithm: SHA256 '401': description: Unauthorized '404': description: Subscription not found x-codeSamples: - lang: Shell + Curl source: "curl --request GET \\\n --url https://marketplace.appdirect.com/api/account/v2/subscriptions/%7BsubscriptionUuid%7D/saml" - lang: Node + Request source: "const request = require('request');\n\nconst options = {\n method: 'GET',\n url: 'https://marketplace.appdirect.com/api/account/v2/subscriptions/%7BsubscriptionUuid%7D/saml'\n};\n\nrequest(options, function (error, response, body) {\n if (error) throw new Error(error);\n\n console.log(body);\n});\n" - lang: Java + Okhttp source: "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://marketplace.appdirect.com/api/account/v2/subscriptions/%7BsubscriptionUuid%7D/saml\")\n .get()\n .build();\n\nResponse response = client.newCall(request).execute();" /billing/v1/companies/{companyId}/subscriptions: get: description: List all of the subscriptions for the given company tags: - Subscriptions summary: List all subscriptions for a company operationId: resource_Other_readCompanySubscriptions_GET parameters: - description: Company ID name: companyId in: path required: true schema: type: string - description: Filters results to only include subscriptions that were created on or after the specified date in yyyy/MM/DD HH:mm:ss format name: fromDate in: query schema: type: string - description: Filters results to only include subscriptions that were created on or before the specified date in yyyy/MM/DD HH:mm:ss format name: toDate in: query schema: type: string - description: Filters subscriptions by internal discount ID name: discountId in: query schema: type: number - description: Filters subscriptions by status name: status in: query schema: type: string items: enum: - INITIALIZED - FAILED - FREE_TRIAL - FREE_TRIAL_EXPIRED - ACTIVE - SUSPENDED - CANCELLED type: string - description: Filters subscriptions by internal edition ID name: editionId in: query schema: type: number - description: Filters subscriptions by internal payment plan ID name: paymentPlanId in: query schema: type: number - description: Filters subscriptions by last modified date name: lastModified in: query schema: type: number - description: Filters subscriptions by internal application ID name: applicationIds in: query schema: type: number - description: Filters subscriptions by internal bundle ID name: bundleApplicationId in: query schema: type: number - description: Expands filtered subscription results to include details about the specified query parameters, one or more of "order", "product", or "edition". name: expand in: query schema: type: string - description: Filters subscriptions by order reference code name: orderReferenceCode in: query schema: type: string - description: Number of results to fetch. Used for paging. name: count in: query schema: type: integer default: 250 - description: Sort field name: sortField in: query schema: type: string enum: - APPLICATION - COMPANY - DATE - OWNER - STATUS - SUBSCRIPTION_ID default: DATE - description: Sort order name: sortOrder in: query schema: type: string enum: - ASC - DESC default: ASC - description: First result index. Used for paging. name: start in: query schema: type: integer default: 0 responses: '200': description: OK content: application/json: schema: description: OK type: array items: $ref: '#/components/schemas/SubscriptionListingWS' examples: response: value: - creationDate: 1481002406580 endDate: null externalAccountId: d2f4acf1-fb5a-4c4a-921f-75c4b6bfff08 status: ACTIVE suspensionReason: API maxUsers: 1 assignmentCount: 1 parentSubscriptionId: null order: id: '1' href: http://appdirect/api/billing/v1/orders/1 user: id: c47d0fd7-b67a-4e07-84f8-f93dfafbeecc href: http://appdirect/api/account/v1/users/c47d0fd7-b67a-4e07-84f8-f93dfafbeecc company: id: e83cd3d6-7865-4fc2-9d7c-603ad17dd639 href: http://appdirect/api/account/v1/companies/e83cd3d6-7865-4fc2-9d7c-603ad17dd639 product: id: '2' href: http://appdirect/api/marketplace/v1/products/2 edition: id: '2' href: http://appdirect/api/marketplace/v1/products/2/editions/2 links: [] id: 1b577640-9b77-47bc-beb8-ed59accb4836 application/xml: schema: description: OK type: array items: $ref: '#/components/schemas/SubscriptionListingWS' '404': description: Not Found x-codeSamples: - lang: Shell + Curl source: "curl --request GET \\\n --url 'https://marketplace.appdirect.com/api/billing/v1/companies/%7BcompanyId%7D/subscriptions?fromDate=SOME_STRING_VALUE&toDate=SOME_STRING_VALUE&discountId=SOME_NUMBER_VALUE&status=SOME_STRING_VALUE&editionId=SOME_NUMBER_VALUE&paymentPlanId=SOME_NUMBER_VALUE&lastModified=SOME_NUMBER_VALUE&applicationIds=SOME_NUMBER_VALUE&bundleApplicationId=SOME_NUMBER_VALUE&expand=SOME_STRING_VALUE&orderReferenceCode=SOME_STRING_VALUE&count=SOME_INTEGER_VALUE&sortField=SOME_STRING_VALUE&sortOrder=SOME_STRING_VALUE&start=SOME_INTEGER_VALUE'" - lang: Node + Request source: "const request = require('request');\n\nconst options = {\n method: 'GET',\n url: 'https://marketplace.appdirect.com/api/billing/v1/companies/%7BcompanyId%7D/subscriptions',\n qs: {\n fromDate: 'SOME_STRING_VALUE',\n toDate: 'SOME_STRING_VALUE',\n discountId: 'SOME_NUMBER_VALUE',\n status: 'SOME_STRING_VALUE',\n editionId: 'SOME_NUMBER_VALUE',\n paymentPlanId: 'SOME_NUMBER_VALUE',\n lastModified: 'SOME_NUMBER_VALUE',\n applicationIds: 'SOME_NUMBER_VALUE',\n bundleApplicationId: 'SOME_NUMBER_VALUE',\n expand: 'SOME_STRING_VALUE',\n orderReferenceCode: 'SOME_STRING_VALUE',\n count: 'SOME_INTEGER_VALUE',\n sortField: 'SOME_STRING_VALUE',\n sortOrder: 'SOME_STRING_VALUE',\n start: 'SOME_INTEGER_VALUE'\n }\n};\n\nrequest(options, function (error, response, body) {\n if (error) throw new Error(error);\n\n console.log(body);\n});\n" - lang: Java + Okhttp source: "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://marketplace.appdirect.com/api/billing/v1/companies/%7BcompanyId%7D/subscriptions?fromDate=SOME_STRING_VALUE&toDate=SOME_STRING_VALUE&discountId=SOME_NUMBER_VALUE&status=SOME_STRING_VALUE&editionId=SOME_NUMBER_VALUE&paymentPlanId=SOME_NUMBER_VALUE&lastModified=SOME_NUMBER_VALUE&applicationIds=SOME_NUMBER_VALUE&bundleApplicationId=SOME_NUMBER_VALUE&expand=SOME_STRING_VALUE&orderReferenceCode=SOME_STRING_VALUE&count=SOME_INTEGER_VALUE&sortField=SOME_STRING_VALUE&sortOrder=SOME_STRING_VALUE&start=SOME_INTEGER_VALUE\")\n .get()\n .build();\n\nResponse response = client.newCall(request).execute();" /billing/v1/companies/{companyId}/users/{userId}/subscriptions/{subscriptionId}: put: description: Change the specified subscription for the specified user and company with the provided data.
You cannot perform assisted sales, in which the buyer purchases a product for or on behalf of someone else, through the API.
When you use the Change Subscription Details request to update a subscription that was created though the user interface as an assisted sale, a new order is created for the specified user ID and company. Because the new order is not created as an assisted sale, the salesSupportUser parameter is returned with a value of null. tags: - Subscriptions summary: Change subscription details operationId: resource_Other_changeSubscription_PUT parameters: - description: User's company ID name: companyId in: path required: true schema: type: string - description: Subscription ID name: subscriptionId in: path required: true schema: type: string - description: User ID name: userId in: path required: true schema: type: string - description: Send notification of the subscription's creation. Default value is true. name: sendNotification in: query schema: type: boolean default: true requestBody: content: application/json: schema: $ref: '#/components/schemas/SubscriptionWS' application/xml: schema: $ref: '#/components/schemas/SubscriptionWS' description: Subscription data object responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SubscriptionWS' examples: response: value: id: 1b577640-9b77-47bc-beb8-ed59accb4836 creationDate: 1481002406580 endDate: null externalAccountId: fdad1b12-c13f-416e-97a2-6330451da1b9 status: ACTIVE maxUsers: 10 assignedUsers: 1 order: startDate: 1480921200000 endDate: null nextBillingDate: 1483599600000 endOfDiscountDate: null status: ACTIVE frequency: MONTHLY currency: USD type: MIGRATION totalPrice: 0 user: id: c47d0fd7-b67a-4e07-84f8-f93dfafbeecc href: http://appdirect/api/account/v1/users/c47d0fd7-b67a-4e07-84f8-f93dfafbeecc salesSupportUser: null company: id: e83cd3d6-7865-4fc2-9d7c-603ad17dd639 href: http://appdirect/api/account/v1/companies/e83cd3d6-7865-4fc2-9d7c-603ad17dd639 referenceCode: null paymentPlan: href: http://appdirect/api/marketplace/v1/products/2/editions/2/paymentPlans/2 id: 2 uuid: eaca1aa5-4c4f-44cb-8cf4-eb0aa9267273 frequency: MONTHLY contract: minimumServiceLength: null cancellationPeriodLimit: null endOfContractGracePeriod: null blockSwitchToShorterContract: false blockContractDowngrades: false blockContractUpgrades: false alignWithParentCycleStartDate: false gracePeriod: null terminationFee: null autoExtensionPricingId: null allowCustomUsage: false keepBillDateOnUsageChange: false separatePrepaid: false isPrimaryPrice: false costs: - id: 2 unit: USER unitDependency: null minUnits: 0 maxUnits: null meteredUsage: false increment: 1 pricePerIncrement: false blockContractDecrease: false blockContractIncrease: false blockOriginalContractDecrease: false amount: USD: 10 pricingStrategy: UNIT discount: null primaryPrice: false contract: null previousOrder: id: '1' href: http://appdirect/api/billing/v1/orders/1 nextOrder: null discount: null paymentPlanId: 2 discountId: null activated: false oneTimeOrders: - startDate: 1480921200000 endDate: 1483599600000 nextBillingDate: 1483599600000 endOfDiscountDate: null status: ONE_TIME frequency: MONTHLY currency: USD type: CREDIT totalPrice: 0 user: null salesSupportUser: null company: null referenceCode: null paymentPlan: id: '2' href: http://appdirect/api/marketplace/v1/products/2/editions/2/paymentPlans/2 links: [] id: 2 orderLines: - id: 3 type: ITEM unit: USER quantity: 10 price: 10 listingPrice: 10 totalPrice: 100 description: Test App 1 - null - Per User Fee parameters: [] links: - rel: subscription href: http://appdirect/api/billing/v1/subscriptions/1b577640-9b77-47bc-beb8-ed59accb4836 id: 3 upcomingOrder: null user: id: c47d0fd7-b67a-4e07-84f8-f93dfafbeecc href: http://appdirect/api/account/v1/users/c47d0fd7-b67a-4e07-84f8-f93dfafbeecc company: id: e83cd3d6-7865-4fc2-9d7c-603ad17dd639 href: http://appdirect/api/account/v1/companies/e83cd3d6-7865-4fc2-9d7c-603ad17dd639 product: id: '2' href: http://appdirect/api/marketplace/v1/products/2 edition: id: '2' href: http://appdirect/api/marketplace/v1/products/2/editions/2 redirectUrl: null application/xml: schema: $ref: '#/components/schemas/SubscriptionWS' '400': description: Bad Request '404': description: Not Found '409': description: Conflict x-codeSamples: - lang: Shell + Curl source: "curl --request PUT \\\n --url 'https://marketplace.appdirect.com/api/billing/v1/companies/%7BcompanyId%7D/users/%7BuserId%7D/subscriptions/%7BsubscriptionId%7D?sendNotification=SOME_BOOLEAN_VALUE' \\\n --data '{\"assignedUsers\":12345,\"bundleApplicationId\":12345,\"company\":{\"href\":\"...\",\"id\":\"...\"},\"creationDate\":12345,\"edition\":{\"href\":\"...\",\"id\":\"...\"},\"endDate\":12345,\"externalAccountId\":\"...\",\"id\":\"...\",\"internalId\":\"...\",\"maxUsers\":12345,\"order\":{\"_embedded\":{\"property1\":{},\"property2\":{}},\"activated\":true,\"company\":{\"href\":\"...\",\"id\":\"...\"},\"contract\":{\"minimumServiceLength\":24,\"endOfContractDate\":123451232,\"gracePeriodEndDate\":null,\"cancellationPeriodLimit\":null,\"endOfContractGracePeriod\":null,\"terminationFee\":{\"type\":\"PERCENTAGE\",\"description\":\"Fee\",\"percentage\":100,\"price\":null,\"estimatedCost\":324.56},\"renewal\":null},\"currency\":\"...\",\"customAttributes\":[{\"attributeType\":\"TEXT\",\"name\":\"...\",\"value\":\"...\",\"valueKeys\":[\"...\",\"...\"]},{\"attributeType\":\"TEXT\",\"name\":\"...\",\"value\":\"...\",\"valueKeys\":[\"...\",\"...\"]}],\"discount\":{\"href\":\"...\",\"id\":\"...\"},\"discountId\":12345,\"endDate\":12345,\"endOfDiscountDate\":12345,\"frequency\":\"...\",\"id\":12345,\"links\":[{\"href\":\"...\",\"rel\":\"...\"},{\"href\":\"...\",\"rel\":\"...\"}],\"nextBillingDate\":12345,\"nextOrder\":{\"href\":\"...\",\"id\":\"...\"},\"oneTimeOrders\":[{\"_embedded\":{\"property1\":{},\"property2\":{}},\"company\":{},\"currency\":\"...\",\"endDate\":12345,\"endOfDiscountDate\":12345,\"frequency\":\"...\",\"id\":12345,\"links\":[{},{}],\"nextBillingDate\":12345,\"paymentPlan\":{},\"referenceCode\":\"...\",\"salesSupportUser\":{},\"startDate\":12345,\"status\":\"...\",\"totalPrice\":12345,\"type\":\"...\",\"user\":{}},{\"_embedded\":{\"property1\":{},\"property2\":{}},\"company\":{},\"currency\":\"...\",\"endDate\":12345,\"endOfDiscountDate\":12345,\"frequency\":\"...\",\"id\":12345,\"links\":[{},{}],\"nextBillingDate\":12345,\"paymentPlan\":{},\"referenceCode\":\"...\",\"salesSupportUser\":{},\"startDate\":12345,\"status\":\"...\",\"totalPrice\":12345,\"type\":\"...\",\"user\":{}}],\"orderLines\":[{},{}],\"parameters\":[{\"name\":\"...\",\"value\":\"...\"},{\"name\":\"...\",\"value\":\"...\"}],\"paymentPlan\":{\"allowCustomUsage\":true,\"contract\":{},\"cost\":[{},{}],\"discount\":{},\"frequency\":\"...\",\"href\":\"...\",\"id\":12345,\"isPrimaryPrice\":true,\"keepBillDateOnUsageChange\":true,\"primaryPrice\":true,\"separatePrepaid\":true,\"tld\":\"...\",\"uuid\":\"...\"},\"paymentPlanId\":12345,\"previousOrder\":{\"href\":\"...\",\"id\":\"...\"},\"referenceCode\":\"...\",\"salesSupportUser\":{\"href\":\"...\",\"id\":\"...\"},\"startDate\":12345,\"status\":\"...\",\"totalPrice\":12345,\"type\":\"...\",\"user\":{\"href\":\"...\",\"id\":\"...\"}},\"product\":{\"href\":\"...\",\"id\":\"...\"},\"redirectUrl\":\"...\",\"status\":\"...\",\"upcomingOrder\":{\"_embedded\":{\"property1\":{},\"property2\":{}},\"activated\":true,\"company\":{\"href\":\"...\",\"id\":\"...\"},\"contract\":{},\"currency\":\"...\",\"customAttributes\":[{\"attributeType\":\"TEXT\",\"name\":\"...\",\"value\":\"...\",\"valueKeys\":[\"...\",\"...\"]},{\"attributeType\":\"TEXT\",\"name\":\"...\",\"value\":\"...\",\"valueKeys\":[\"...\",\"...\"]}],\"discount\":{\"href\":\"...\",\"id\":\"...\"},\"discountId\":12345,\"endDate\":12345,\"endOfDiscountDate\":12345,\"frequency\":\"...\",\"id\":12345,\"links\":[{\"href\":\"...\",\"rel\":\"...\"},{\"href\":\"...\",\"rel\":\"...\"}],\"nextBillingDate\":12345,\"nextOrder\":{\"href\":\"...\",\"id\":\"...\"},\"oneTimeOrders\":[{\"_embedded\":{\"property1\":{},\"property2\":{}},\"company\":{},\"currency\":\"...\",\"endDate\":12345,\"endOfDiscountDate\":12345,\"frequency\":\"...\",\"id\":12345,\"links\":[{},{}],\"nextBillingDate\":12345,\"paymentPlan\":{},\"referenceCode\":\"...\",\"salesSupportUser\":{},\"startDate\":12345,\"status\":\"...\",\"totalPrice\":12345,\"type\":\"...\",\"user\":{}},{\"_embedded\":{\"property1\":{},\"property2\":{}},\"company\":{},\"currency\":\"...\",\"endDate\":12345,\"endOfDiscountDate\":12345,\"frequency\":\"...\",\"id\":12345,\"links\":[{},{}],\"nextBillingDate\":12345,\"paymentPlan\":{},\"referenceCode\":\"...\",\"salesSupportUser\":{},\"startDate\":12345,\"status\":\"...\",\"totalPrice\":12345,\"type\":\"...\",\"user\":{}}],\"orderLines\":[{},{}],\"parameters\":[{\"name\":\"...\",\"value\":\"...\"},{\"name\":\"...\",\"value\":\"...\"}],\"paymentPlan\":{\"allowCustomUsage\":true,\"contract\":{},\"cost\":[{},{}],\"discount\":{},\"frequency\":\"...\",\"href\":\"...\",\"id\":12345,\"isPrimaryPrice\":true,\"keepBillDateOnUsageChange\":true,\"primaryPrice\":true,\"separatePrepaid\":true,\"tld\":\"...\",\"uuid\":\"...\"},\"paymentPlanId\":12345,\"previousOrder\":{\"href\":\"...\",\"id\":\"...\"},\"referenceCode\":\"...\",\"salesSupportUser\":{\"href\":\"...\",\"id\":\"...\"},\"startDate\":12345,\"status\":\"...\",\"totalPrice\":12345,\"type\":\"...\",\"user\":{\"href\":\"...\",\"id\":\"...\"}},\"user\":{\"href\":\"...\",\"id\":\"...\"}}'" - lang: Node + Request source: "const request = require('request');\n\nconst options = {\n method: 'PUT',\n url: 'https://marketplace.appdirect.com/api/billing/v1/companies/%7BcompanyId%7D/users/%7BuserId%7D/subscriptions/%7BsubscriptionId%7D',\n qs: {sendNotification: 'SOME_BOOLEAN_VALUE'},\n body: {\n assignedUsers: 12345,\n bundleApplicationId: 12345,\n company: {href: '...', id: '...'},\n creationDate: 12345,\n edition: {href: '...', id: '...'},\n endDate: 12345,\n externalAccountId: '...',\n id: '...',\n internalId: '...',\n maxUsers: 12345,\n order: {\n _embedded: {property1: {}, property2: {}},\n activated: true,\n company: {href: '...', id: '...'},\n contract: {\n minimumServiceLength: 24,\n endOfContractDate: 123451232,\n gracePeriodEndDate: null,\n cancellationPeriodLimit: null,\n endOfContractGracePeriod: null,\n terminationFee: {\n type: 'PERCENTAGE',\n description: 'Fee',\n percentage: 100,\n price: null,\n estimatedCost: 324.56\n },\n renewal: null\n },\n currency: '...',\n customAttributes: [\n {attributeType: 'TEXT', name: '...', value: '...', valueKeys: ['...', '...']},\n {attributeType: 'TEXT', name: '...', value: '...', valueKeys: ['...', '...']}\n ],\n discount: {href: '...', id: '...'},\n discountId: 12345,\n endDate: 12345,\n endOfDiscountDate: 12345,\n frequency: '...',\n id: 12345,\n links: [{href: '...', rel: '...'}, {href: '...', rel: '...'}],\n nextBillingDate: 12345,\n nextOrder: {href: '...', id: '...'},\n oneTimeOrders: [\n {\n _embedded: {property1: {}, property2: {}},\n company: {},\n currency: '...',\n endDate: 12345,\n endOfDiscountDate: 12345,\n frequency: '...',\n id: 12345,\n links: [{}, {}],\n nextBillingDate: 12345,\n paymentPlan: {},\n referenceCode: '...',\n salesSupportUser: {},\n startDate: 12345,\n status: '...',\n totalPrice: 12345,\n type: '...',\n user: {}\n },\n {\n _embedded: {property1: {}, property2: {}},\n company: {},\n currency: '...',\n endDate: 12345,\n endOfDiscountDate: 12345,\n frequency: '...',\n id: 12345,\n links: [{}, {}],\n nextBillingDate: 12345,\n paymentPlan: {},\n referenceCode: '...',\n salesSupportUser: {},\n startDate: 12345,\n status: '...',\n totalPrice: 12345,\n type: '...',\n user: {}\n }\n ],\n orderLines: [{}, {}],\n parameters: [{name: '...', value: '...'}, {name: '...', value: '...'}],\n paymentPlan: {\n allowCustomUsage: true,\n contract: {},\n cost: [{}, {}],\n discount: {},\n frequency: '...',\n href: '...',\n id: 12345,\n isPrimaryPrice: true,\n keepBillDateOnUsageChange: true,\n primaryPrice: true,\n separatePrepaid: true,\n tld: '...',\n uuid: '...'\n },\n paymentPlanId: 12345,\n previousOrder: {href: '...', id: '...'},\n referenceCode: '...',\n salesSupportUser: {href: '...', id: '...'},\n startDate: 12345,\n status: '...',\n totalPrice: 12345,\n type: '...',\n user: {href: '...', id: '...'}\n },\n product: {href: '...', id: '...'},\n redirectUrl: '...',\n status: '...',\n upcomingOrder: {\n _embedded: {property1: {}, property2: {}},\n activated: true,\n company: {href: '...', id: '...'},\n contract: {},\n currency: '...',\n customAttributes: [\n {attributeType: 'TEXT', name: '...', value: '...', valueKeys: ['...', '...']},\n {attributeType: 'TEXT', name: '...', value: '...', valueKeys: ['...', '...']}\n ],\n discount: {href: '...', id: '...'},\n discountId: 12345,\n endDate: 12345,\n endOfDiscountDate: 12345,\n frequency: '...',\n id: 12345,\n links: [{href: '...', rel: '...'}, {href: '...', rel: '...'}],\n nextBillingDate: 12345,\n nextOrder: {href: '...', id: '...'},\n oneTimeOrders: [\n {\n _embedded: {property1: {}, property2: {}},\n company: {},\n currency: '...',\n endDate: 12345,\n endOfDiscountDate: 12345,\n frequency: '...',\n id: 12345,\n links: [{}, {}],\n nextBillingDate: 12345,\n paymentPlan: {},\n referenceCode: '...',\n salesSupportUser: {},\n startDate: 12345,\n status: '...',\n totalPrice: 12345,\n type: '...',\n user: {}\n },\n {\n _embedded: {property1: {}, property2: {}},\n company: {},\n currency: '...',\n endDate: 12345,\n endOfDiscountDate: 12345,\n frequency: '...',\n id: 12345,\n links: [{}, {}],\n nextBillingDate: 12345,\n paymentPlan: {},\n referenceCode: '...',\n salesSupportUser: {},\n startDate: 12345,\n status: '...',\n totalPrice: 12345,\n type: '...',\n user: {}\n }\n ],\n orderLines: [{}, {}],\n parameters: [{name: '...', value: '...'}, {name: '...', value: '...'}],\n paymentPlan: {\n allowCustomUsage: true,\n contract: {},\n cost: [{}, {}],\n discount: {},\n frequency: '...',\n href: '...',\n id: 12345,\n isPrimaryPrice: true,\n keepBillDateOnUsageChange: true,\n primaryPrice: true,\n separatePrepaid: true,\n tld: '...',\n uuid: '...'\n },\n paymentPlanId: 12345,\n previousOrder: {href: '...', id: '...'},\n referenceCode: '...',\n salesSupportUser: {href: '...', id: '...'},\n startDate: 12345,\n status: '...',\n totalPrice: 12345,\n type: '...',\n user: {href: '...', id: '...'}\n },\n user: {href: '...', id: '...'}\n },\n json: true\n};\n\nrequest(options, function (error, response, body) {\n if (error) throw new Error(error);\n\n console.log(body);\n});\n" - lang: Java + Okhttp source: "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"assignedUsers\\\":12345,\\\"bundleApplicationId\\\":12345,\\\"company\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"},\\\"creationDate\\\":12345,\\\"edition\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"},\\\"endDate\\\":12345,\\\"externalAccountId\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\",\\\"internalId\\\":\\\"...\\\",\\\"maxUsers\\\":12345,\\\"order\\\":{\\\"_embedded\\\":{\\\"property1\\\":{},\\\"property2\\\":{}},\\\"activated\\\":true,\\\"company\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"},\\\"contract\\\":{\\\"minimumServiceLength\\\":24,\\\"endOfContractDate\\\":123451232,\\\"gracePeriodEndDate\\\":null,\\\"cancellationPeriodLimit\\\":null,\\\"endOfContractGracePeriod\\\":null,\\\"terminationFee\\\":{\\\"type\\\":\\\"PERCENTAGE\\\",\\\"description\\\":\\\"Fee\\\",\\\"percentage\\\":100,\\\"price\\\":null,\\\"estimatedCost\\\":324.56},\\\"renewal\\\":null},\\\"currency\\\":\\\"...\\\",\\\"customAttributes\\\":[{\\\"attributeType\\\":\\\"TEXT\\\",\\\"name\\\":\\\"...\\\",\\\"value\\\":\\\"...\\\",\\\"valueKeys\\\":[\\\"...\\\",\\\"...\\\"]},{\\\"attributeType\\\":\\\"TEXT\\\",\\\"name\\\":\\\"...\\\",\\\"value\\\":\\\"...\\\",\\\"valueKeys\\\":[\\\"...\\\",\\\"...\\\"]}],\\\"discount\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"},\\\"discountId\\\":12345,\\\"endDate\\\":12345,\\\"endOfDiscountDate\\\":12345,\\\"frequency\\\":\\\"...\\\",\\\"id\\\":12345,\\\"links\\\":[{\\\"href\\\":\\\"...\\\",\\\"rel\\\":\\\"...\\\"},{\\\"href\\\":\\\"...\\\",\\\"rel\\\":\\\"...\\\"}],\\\"nextBillingDate\\\":12345,\\\"nextOrder\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"},\\\"oneTimeOrders\\\":[{\\\"_embedded\\\":{\\\"property1\\\":{},\\\"property2\\\":{}},\\\"company\\\":{},\\\"currency\\\":\\\"...\\\",\\\"endDate\\\":12345,\\\"endOfDiscountDate\\\":12345,\\\"frequency\\\":\\\"...\\\",\\\"id\\\":12345,\\\"links\\\":[{},{}],\\\"nextBillingDate\\\":12345,\\\"paymentPlan\\\":{},\\\"referenceCode\\\":\\\"...\\\",\\\"salesSupportUser\\\":{},\\\"startDate\\\":12345,\\\"status\\\":\\\"...\\\",\\\"totalPrice\\\":12345,\\\"type\\\":\\\"...\\\",\\\"user\\\":{}},{\\\"_embedded\\\":{\\\"property1\\\":{},\\\"property2\\\":{}},\\\"company\\\":{},\\\"currency\\\":\\\"...\\\",\\\"endDate\\\":12345,\\\"endOfDiscountDate\\\":12345,\\\"frequency\\\":\\\"...\\\",\\\"id\\\":12345,\\\"links\\\":[{},{}],\\\"nextBillingDate\\\":12345,\\\"paymentPlan\\\":{},\\\"referenceCode\\\":\\\"...\\\",\\\"salesSupportUser\\\":{},\\\"startDate\\\":12345,\\\"status\\\":\\\"...\\\",\\\"totalPrice\\\":12345,\\\"type\\\":\\\"...\\\",\\\"user\\\":{}}],\\\"orderLines\\\":[{},{}],\\\"parameters\\\":[{\\\"name\\\":\\\"...\\\",\\\"value\\\":\\\"...\\\"},{\\\"name\\\":\\\"...\\\",\\\"value\\\":\\\"...\\\"}],\\\"paymentPlan\\\":{\\\"allowCustomUsage\\\":true,\\\"contract\\\":{},\\\"cost\\\":[{},{}],\\\"discount\\\":{},\\\"frequency\\\":\\\"...\\\",\\\"href\\\":\\\"...\\\",\\\"id\\\":12345,\\\"isPrimaryPrice\\\":true,\\\"keepBillDateOnUsageChange\\\":true,\\\"primaryPrice\\\":true,\\\"separatePrepaid\\\":true,\\\"tld\\\":\\\"...\\\",\\\"uuid\\\":\\\"...\\\"},\\\"paymentPlanId\\\":12345,\\\"previousOrder\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"},\\\"referenceCode\\\":\\\"...\\\",\\\"salesSupportUser\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"},\\\"startDate\\\":12345,\\\"status\\\":\\\"...\\\",\\\"totalPrice\\\":12345,\\\"type\\\":\\\"...\\\",\\\"user\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"}},\\\"product\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"},\\\"redirectUrl\\\":\\\"...\\\",\\\"status\\\":\\\"...\\\",\\\"upcomingOrder\\\":{\\\"_embedded\\\":{\\\"property1\\\":{},\\\"property2\\\":{}},\\\"activated\\\":true,\\\"company\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"},\\\"contract\\\":{},\\\"currency\\\":\\\"...\\\",\\\"customAttributes\\\":[{\\\"attributeType\\\":\\\"TEXT\\\",\\\"name\\\":\\\"...\\\",\\\"value\\\":\\\"...\\\",\\\"valueKeys\\\":[\\\"...\\\",\\\"...\\\"]},{\\\"attributeType\\\":\\\"TEXT\\\",\\\"name\\\":\\\"...\\\",\\\"value\\\":\\\"...\\\",\\\"valueKeys\\\":[\\\"...\\\",\\\"...\\\"]}],\\\"discount\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"},\\\"discountId\\\":12345,\\\"endDate\\\":12345,\\\"endOfDiscountDate\\\":12345,\\\"frequency\\\":\\\"...\\\",\\\"id\\\":12345,\\\"links\\\":[{\\\"href\\\":\\\"...\\\",\\\"rel\\\":\\\"...\\\"},{\\\"href\\\":\\\"...\\\",\\\"rel\\\":\\\"...\\\"}],\\\"nextBillingDate\\\":12345,\\\"nextOrder\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"},\\\"oneTimeOrders\\\":[{\\\"_embedded\\\":{\\\"property1\\\":{},\\\"property2\\\":{}},\\\"company\\\":{},\\\"currency\\\":\\\"...\\\",\\\"endDate\\\":12345,\\\"endOfDiscountDate\\\":12345,\\\"frequency\\\":\\\"...\\\",\\\"id\\\":12345,\\\"links\\\":[{},{}],\\\"nextBillingDate\\\":12345,\\\"paymentPlan\\\":{},\\\"referenceCode\\\":\\\"...\\\",\\\"salesSupportUser\\\":{},\\\"startDate\\\":12345,\\\"status\\\":\\\"...\\\",\\\"totalPrice\\\":12345,\\\"type\\\":\\\"...\\\",\\\"user\\\":{}},{\\\"_embedded\\\":{\\\"property1\\\":{},\\\"property2\\\":{}},\\\"company\\\":{},\\\"currency\\\":\\\"...\\\",\\\"endDate\\\":12345,\\\"endOfDiscountDate\\\":12345,\\\"frequency\\\":\\\"...\\\",\\\"id\\\":12345,\\\"links\\\":[{},{}],\\\"nextBillingDate\\\":12345,\\\"paymentPlan\\\":{},\\\"referenceCode\\\":\\\"...\\\",\\\"salesSupportUser\\\":{},\\\"startDate\\\":12345,\\\"status\\\":\\\"...\\\",\\\"totalPrice\\\":12345,\\\"type\\\":\\\"...\\\",\\\"user\\\":{}}],\\\"orderLines\\\":[{},{}],\\\"parameters\\\":[{\\\"name\\\":\\\"...\\\",\\\"value\\\":\\\"...\\\"},{\\\"name\\\":\\\"...\\\",\\\"value\\\":\\\"...\\\"}],\\\"paymentPlan\\\":{\\\"allowCustomUsage\\\":true,\\\"contract\\\":{},\\\"cost\\\":[{},{}],\\\"discount\\\":{},\\\"frequency\\\":\\\"...\\\",\\\"href\\\":\\\"...\\\",\\\"id\\\":12345,\\\"isPrimaryPrice\\\":true,\\\"keepBillDateOnUsageChange\\\":true,\\\"primaryPrice\\\":true,\\\"separatePrepaid\\\":true,\\\"tld\\\":\\\"...\\\",\\\"uuid\\\":\\\"...\\\"},\\\"paymentPlanId\\\":12345,\\\"previousOrder\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"},\\\"referenceCode\\\":\\\"...\\\",\\\"salesSupportUser\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"},\\\"startDate\\\":12345,\\\"status\\\":\\\"...\\\",\\\"totalPrice\\\":12345,\\\"type\\\":\\\"...\\\",\\\"user\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"}},\\\"user\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"}}\");\nRequest request = new Request.Builder()\n .url(\"https://marketplace.appdirect.com/api/billing/v1/companies/%7BcompanyId%7D/users/%7BuserId%7D/subscriptions/%7BsubscriptionId%7D?sendNotification=SOME_BOOLEAN_VALUE\")\n .put(body)\n .build();\n\nResponse response = client.newCall(request).execute();" /billing/v1/companies/{companyId}/users/{userId}/subscriptions: get: description: List all of the subscriptions for the given user tags: - Subscriptions summary: List all subscriptions for a user operationId: resource_Other_readUserSubscriptions_GET parameters: - description: User's company ID name: companyId in: path required: true schema: type: string - description: User ID name: userId in: path required: true schema: type: string - description: Filters results to only include subscriptions that were created on or after the specified date in yyyy/MM/DD HH:mm:ss format name: fromDate in: query schema: type: string - description: Filters results to only include subscriptions that were created on or before the specified date in yyyy/MM/DD HH:mm:ss format name: toDate in: query schema: type: string - description: Filters subscriptions by internal discount ID name: discountId in: query schema: type: number - description: Filters subscriptions by order status name: status in: query schema: type: string items: enum: - INITIALIZED - FAILED - FREE_TRIAL - FREE_TRIAL_EXPIRED - ACTIVE - SUSPENDED - CANCELLED type: string - description: Filters subscriptions by internal edition ID name: editionId in: query schema: type: number - description: Filters subscriptions by internal payment plan ID name: paymentPlanId in: query schema: type: number - description: Filters subscriptions by last modified date name: lastModified in: query schema: type: number - description: Filters subscriptions by internal application ID name: applicationIds in: query schema: type: number - description: Filters subscriptions by internal bundle ID name: bundleApplicationId in: query schema: type: number - description: Expands filtered subscription results to include details about the specified query parameters, one or more of "order", "product", or "edition". name: expand in: query schema: type: string - description: Filters subscriptions by order reference code name: orderReferenceCode in: query schema: type: string - description: Number of results to fetch. Used for paging. name: count in: query schema: type: integer default: 250 - description: Sort field name: sortField in: query schema: type: string enum: - APPLICATION - COMPANY - DATE - OWNER - STATUS - SUBSCRIPTION_ID default: DATE - description: Sort order name: sortOrder in: query schema: type: string enum: - ASC - DESC default: ASC - description: First result index. Used for paging. name: start in: query schema: type: integer default: 0 responses: '200': description: OK content: application/json: schema: description: OK type: array items: $ref: '#/components/schemas/SubscriptionListingWS' examples: response: value: - creationDate: 1481002406580 endDate: null externalAccountId: d2f4acf1-fb5a-4c4a-921f-75c4b6bfff08 status: ACTIVE suspensionReason: API maxUsers: 1 assignmentCount: 1 parentSubscriptionId: null order: id: '1' href: http://appdirect/api/billing/v1/orders/1 user: id: c47d0fd7-b67a-4e07-84f8-f93dfafbeecc href: http://appdirect/api/account/v1/users/c47d0fd7-b67a-4e07-84f8-f93dfafbeecc company: id: e83cd3d6-7865-4fc2-9d7c-603ad17dd639 href: http://appdirect/api/account/v1/companies/e83cd3d6-7865-4fc2-9d7c-603ad17dd639 product: id: '2' href: http://appdirect/api/marketplace/v1/products/2 edition: id: '2' href: http://appdirect/api/marketplace/v1/products/2/editions/2 links: [] id: 1b577640-9b77-47bc-beb8-ed59accb4836 application/xml: schema: description: OK type: array items: $ref: '#/components/schemas/SubscriptionListingWS' '404': description: Not Found x-codeSamples: - lang: Shell + Curl source: "curl --request GET \\\n --url 'https://marketplace.appdirect.com/api/billing/v1/companies/%7BcompanyId%7D/users/%7BuserId%7D/subscriptions?fromDate=SOME_STRING_VALUE&toDate=SOME_STRING_VALUE&discountId=SOME_NUMBER_VALUE&status=SOME_STRING_VALUE&editionId=SOME_NUMBER_VALUE&paymentPlanId=SOME_NUMBER_VALUE&lastModified=SOME_NUMBER_VALUE&applicationIds=SOME_NUMBER_VALUE&bundleApplicationId=SOME_NUMBER_VALUE&expand=SOME_STRING_VALUE&orderReferenceCode=SOME_STRING_VALUE&count=SOME_INTEGER_VALUE&sortField=SOME_STRING_VALUE&sortOrder=SOME_STRING_VALUE&start=SOME_INTEGER_VALUE'" - lang: Node + Request source: "const request = require('request');\n\nconst options = {\n method: 'GET',\n url: 'https://marketplace.appdirect.com/api/billing/v1/companies/%7BcompanyId%7D/users/%7BuserId%7D/subscriptions',\n qs: {\n fromDate: 'SOME_STRING_VALUE',\n toDate: 'SOME_STRING_VALUE',\n discountId: 'SOME_NUMBER_VALUE',\n status: 'SOME_STRING_VALUE',\n editionId: 'SOME_NUMBER_VALUE',\n paymentPlanId: 'SOME_NUMBER_VALUE',\n lastModified: 'SOME_NUMBER_VALUE',\n applicationIds: 'SOME_NUMBER_VALUE',\n bundleApplicationId: 'SOME_NUMBER_VALUE',\n expand: 'SOME_STRING_VALUE',\n orderReferenceCode: 'SOME_STRING_VALUE',\n count: 'SOME_INTEGER_VALUE',\n sortField: 'SOME_STRING_VALUE',\n sortOrder: 'SOME_STRING_VALUE',\n start: 'SOME_INTEGER_VALUE'\n }\n};\n\nrequest(options, function (error, response, body) {\n if (error) throw new Error(error);\n\n console.log(body);\n});\n" - lang: Java + Okhttp source: "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://marketplace.appdirect.com/api/billing/v1/companies/%7BcompanyId%7D/users/%7BuserId%7D/subscriptions?fromDate=SOME_STRING_VALUE&toDate=SOME_STRING_VALUE&discountId=SOME_NUMBER_VALUE&status=SOME_STRING_VALUE&editionId=SOME_NUMBER_VALUE&paymentPlanId=SOME_NUMBER_VALUE&lastModified=SOME_NUMBER_VALUE&applicationIds=SOME_NUMBER_VALUE&bundleApplicationId=SOME_NUMBER_VALUE&expand=SOME_STRING_VALUE&orderReferenceCode=SOME_STRING_VALUE&count=SOME_INTEGER_VALUE&sortField=SOME_STRING_VALUE&sortOrder=SOME_STRING_VALUE&start=SOME_INTEGER_VALUE\")\n .get()\n .build();\n\nResponse response = client.newCall(request).execute();" post: description: Create a subscription for the given user and company using the provided data tags: - Subscriptions summary: Create a subscription operationId: resource_Other_createSubscription_POST parameters: - description: User's company ID name: companyId in: path required: true schema: type: string - description: User ID name: userId in: path required: true schema: type: string - description: Send notification of the subscription's creation. Default value is true. name: sendNotification in: query schema: type: boolean default: true requestBody: content: application/json: schema: $ref: '#/components/schemas/SubscriptionWS' application/xml: schema: $ref: '#/components/schemas/SubscriptionWS' description: Subscription data object responses: '201': headers: Location: schema: type: string description: Created content: application/xml: schema: $ref: '#/components/schemas/SubscriptionWS' application/json: schema: $ref: '#/components/schemas/SubscriptionWS' examples: response: value: id: 1b577640-9b77-47bc-beb8-ed59accb4836 creationDate: 1481002406580 endDate: null externalAccountId: d2f4acf1-fb5a-4c4a-921f-75c4b6bfff08 status: ACTIVE maxUsers: 1 assignedUsers: 1 order: startDate: 1480921200000 endDate: null nextBillingDate: 1483599600000 endOfDiscountDate: null status: ACTIVE frequency: MONTHLY currency: USD type: NEW totalPrice: 0 user: id: c47d0fd7-b67a-4e07-84f8-f93dfafbeecc href: http://appdirect/api/account/v1/users/c47d0fd7-b67a-4e07-84f8-f93dfafbeecc salesSupportUser: null company: id: e83cd3d6-7865-4fc2-9d7c-603ad17dd639 href: http://appdirect/api/account/v1/companies/e83cd3d6-7865-4fc2-9d7c-603ad17dd639 referenceCode: null paymentPlan: href: http://appdirect/api/marketplace/v1/products/2/editions/2/paymentPlans/2 id: 2 uuid: eaca1aa5-4c4f-44cb-8cf4-eb0aa9267273 frequency: MONTHLY contract: minimumServiceLength: null cancellationPeriodLimit: null endOfContractGracePeriod: null blockSwitchToShorterContract: false blockContractDowngrades: false blockContractUpgrades: false alignWithParentCycleStartDate: false gracePeriod: null terminationFee: null autoExtensionPricingId: null allowCustomUsage: false keepBillDateOnUsageChange: false separatePrepaid: false isPrimaryPrice: false costs: - id: 2 unit: USER unitDependency: null minUnits: 0 maxUnits: null meteredUsage: false increment: 1 pricePerIncrement: false blockContractDecrease: false blockContractIncrease: false blockOriginalContractDecrease: false amount: USD: 10 pricingStrategy: UNIT discount: null primaryPrice: false contract: null previousOrder: null nextOrder: null discount: null paymentPlanId: 2 discountId: null activated: false oneTimeOrders: [] orderLines: - id: 1 type: ITEM unit: USER quantity: 1 price: 10 listingPrice: 10 totalPrice: 10 description: Test App 1 - null - Per User Fee parameters: [] links: - rel: subscription href: http://appdirect/api/billing/v1/subscriptions/1b577640-9b77-47bc-beb8-ed59accb4836 id: 1 upcomingOrder: null user: id: c47d0fd7-b67a-4e07-84f8-f93dfafbeecc href: http://appdirect/api/account/v1/users/c47d0fd7-b67a-4e07-84f8-f93dfafbeecc company: id: e83cd3d6-7865-4fc2-9d7c-603ad17dd639 href: http://appdirect/api/account/v1/companies/e83cd3d6-7865-4fc2-9d7c-603ad17dd639 product: id: '2' href: http://appdirect/api/marketplace/v1/products/2 edition: id: '2' href: http://appdirect/api/marketplace/v1/products/2/editions/2 redirectUrl: null headers: examples: response: value: Location: http://appdirect/api/billing/v1/companies/e83cd3d6-7865-4fc2-9d7c-603ad17dd639/users/c47d0fd7-b67a-4e07-84f8-f93dfafbeecc/subscriptions/1b577640-9b77-47bc-beb8-ed59accb4836 '400': description: Bad Request '404': description: Not Found '409': description: Conflict x-codeSamples: - lang: Shell + Curl source: "curl --request POST \\\n --url 'https://marketplace.appdirect.com/api/billing/v1/companies/%7BcompanyId%7D/users/%7BuserId%7D/subscriptions?sendNotification=SOME_BOOLEAN_VALUE' \\\n --data '{\"assignedUsers\":12345,\"bundleApplicationId\":12345,\"company\":{\"href\":\"...\",\"id\":\"...\"},\"creationDate\":12345,\"edition\":{\"href\":\"...\",\"id\":\"...\"},\"endDate\":12345,\"externalAccountId\":\"...\",\"id\":\"...\",\"internalId\":\"...\",\"maxUsers\":12345,\"order\":{\"_embedded\":{\"property1\":{},\"property2\":{}},\"activated\":true,\"company\":{\"href\":\"...\",\"id\":\"...\"},\"contract\":{\"minimumServiceLength\":24,\"endOfContractDate\":123451232,\"gracePeriodEndDate\":null,\"cancellationPeriodLimit\":null,\"endOfContractGracePeriod\":null,\"terminationFee\":{\"type\":\"PERCENTAGE\",\"description\":\"Fee\",\"percentage\":100,\"price\":null,\"estimatedCost\":324.56},\"renewal\":null},\"currency\":\"...\",\"customAttributes\":[{\"attributeType\":\"TEXT\",\"name\":\"...\",\"value\":\"...\",\"valueKeys\":[\"...\",\"...\"]},{\"attributeType\":\"TEXT\",\"name\":\"...\",\"value\":\"...\",\"valueKeys\":[\"...\",\"...\"]}],\"discount\":{\"href\":\"...\",\"id\":\"...\"},\"discountId\":12345,\"endDate\":12345,\"endOfDiscountDate\":12345,\"frequency\":\"...\",\"id\":12345,\"links\":[{\"href\":\"...\",\"rel\":\"...\"},{\"href\":\"...\",\"rel\":\"...\"}],\"nextBillingDate\":12345,\"nextOrder\":{\"href\":\"...\",\"id\":\"...\"},\"oneTimeOrders\":[{\"_embedded\":{\"property1\":{},\"property2\":{}},\"company\":{},\"currency\":\"...\",\"endDate\":12345,\"endOfDiscountDate\":12345,\"frequency\":\"...\",\"id\":12345,\"links\":[{},{}],\"nextBillingDate\":12345,\"paymentPlan\":{},\"referenceCode\":\"...\",\"salesSupportUser\":{},\"startDate\":12345,\"status\":\"...\",\"totalPrice\":12345,\"type\":\"...\",\"user\":{}},{\"_embedded\":{\"property1\":{},\"property2\":{}},\"company\":{},\"currency\":\"...\",\"endDate\":12345,\"endOfDiscountDate\":12345,\"frequency\":\"...\",\"id\":12345,\"links\":[{},{}],\"nextBillingDate\":12345,\"paymentPlan\":{},\"referenceCode\":\"...\",\"salesSupportUser\":{},\"startDate\":12345,\"status\":\"...\",\"totalPrice\":12345,\"type\":\"...\",\"user\":{}}],\"orderLines\":[{},{}],\"parameters\":[{\"name\":\"...\",\"value\":\"...\"},{\"name\":\"...\",\"value\":\"...\"}],\"paymentPlan\":{\"allowCustomUsage\":true,\"contract\":{},\"cost\":[{},{}],\"discount\":{},\"frequency\":\"...\",\"href\":\"...\",\"id\":12345,\"isPrimaryPrice\":true,\"keepBillDateOnUsageChange\":true,\"primaryPrice\":true,\"separatePrepaid\":true,\"tld\":\"...\",\"uuid\":\"...\"},\"paymentPlanId\":12345,\"previousOrder\":{\"href\":\"...\",\"id\":\"...\"},\"referenceCode\":\"...\",\"salesSupportUser\":{\"href\":\"...\",\"id\":\"...\"},\"startDate\":12345,\"status\":\"...\",\"totalPrice\":12345,\"type\":\"...\",\"user\":{\"href\":\"...\",\"id\":\"...\"}},\"product\":{\"href\":\"...\",\"id\":\"...\"},\"redirectUrl\":\"...\",\"status\":\"...\",\"upcomingOrder\":{\"_embedded\":{\"property1\":{},\"property2\":{}},\"activated\":true,\"company\":{\"href\":\"...\",\"id\":\"...\"},\"contract\":{},\"currency\":\"...\",\"customAttributes\":[{\"attributeType\":\"TEXT\",\"name\":\"...\",\"value\":\"...\",\"valueKeys\":[\"...\",\"...\"]},{\"attributeType\":\"TEXT\",\"name\":\"...\",\"value\":\"...\",\"valueKeys\":[\"...\",\"...\"]}],\"discount\":{\"href\":\"...\",\"id\":\"...\"},\"discountId\":12345,\"endDate\":12345,\"endOfDiscountDate\":12345,\"frequency\":\"...\",\"id\":12345,\"links\":[{\"href\":\"...\",\"rel\":\"...\"},{\"href\":\"...\",\"rel\":\"...\"}],\"nextBillingDate\":12345,\"nextOrder\":{\"href\":\"...\",\"id\":\"...\"},\"oneTimeOrders\":[{\"_embedded\":{\"property1\":{},\"property2\":{}},\"company\":{},\"currency\":\"...\",\"endDate\":12345,\"endOfDiscountDate\":12345,\"frequency\":\"...\",\"id\":12345,\"links\":[{},{}],\"nextBillingDate\":12345,\"paymentPlan\":{},\"referenceCode\":\"...\",\"salesSupportUser\":{},\"startDate\":12345,\"status\":\"...\",\"totalPrice\":12345,\"type\":\"...\",\"user\":{}},{\"_embedded\":{\"property1\":{},\"property2\":{}},\"company\":{},\"currency\":\"...\",\"endDate\":12345,\"endOfDiscountDate\":12345,\"frequency\":\"...\",\"id\":12345,\"links\":[{},{}],\"nextBillingDate\":12345,\"paymentPlan\":{},\"referenceCode\":\"...\",\"salesSupportUser\":{},\"startDate\":12345,\"status\":\"...\",\"totalPrice\":12345,\"type\":\"...\",\"user\":{}}],\"orderLines\":[{},{}],\"parameters\":[{\"name\":\"...\",\"value\":\"...\"},{\"name\":\"...\",\"value\":\"...\"}],\"paymentPlan\":{\"allowCustomUsage\":true,\"contract\":{},\"cost\":[{},{}],\"discount\":{},\"frequency\":\"...\",\"href\":\"...\",\"id\":12345,\"isPrimaryPrice\":true,\"keepBillDateOnUsageChange\":true,\"primaryPrice\":true,\"separatePrepaid\":true,\"tld\":\"...\",\"uuid\":\"...\"},\"paymentPlanId\":12345,\"previousOrder\":{\"href\":\"...\",\"id\":\"...\"},\"referenceCode\":\"...\",\"salesSupportUser\":{\"href\":\"...\",\"id\":\"...\"},\"startDate\":12345,\"status\":\"...\",\"totalPrice\":12345,\"type\":\"...\",\"user\":{\"href\":\"...\",\"id\":\"...\"}},\"user\":{\"href\":\"...\",\"id\":\"...\"}}'" - lang: Node + Request source: "const request = require('request');\n\nconst options = {\n method: 'POST',\n url: 'https://marketplace.appdirect.com/api/billing/v1/companies/%7BcompanyId%7D/users/%7BuserId%7D/subscriptions',\n qs: {sendNotification: 'SOME_BOOLEAN_VALUE'},\n body: {\n assignedUsers: 12345,\n bundleApplicationId: 12345,\n company: {href: '...', id: '...'},\n creationDate: 12345,\n edition: {href: '...', id: '...'},\n endDate: 12345,\n externalAccountId: '...',\n id: '...',\n internalId: '...',\n maxUsers: 12345,\n order: {\n _embedded: {property1: {}, property2: {}},\n activated: true,\n company: {href: '...', id: '...'},\n contract: {\n minimumServiceLength: 24,\n endOfContractDate: 123451232,\n gracePeriodEndDate: null,\n cancellationPeriodLimit: null,\n endOfContractGracePeriod: null,\n terminationFee: {\n type: 'PERCENTAGE',\n description: 'Fee',\n percentage: 100,\n price: null,\n estimatedCost: 324.56\n },\n renewal: null\n },\n currency: '...',\n customAttributes: [\n {attributeType: 'TEXT', name: '...', value: '...', valueKeys: ['...', '...']},\n {attributeType: 'TEXT', name: '...', value: '...', valueKeys: ['...', '...']}\n ],\n discount: {href: '...', id: '...'},\n discountId: 12345,\n endDate: 12345,\n endOfDiscountDate: 12345,\n frequency: '...',\n id: 12345,\n links: [{href: '...', rel: '...'}, {href: '...', rel: '...'}],\n nextBillingDate: 12345,\n nextOrder: {href: '...', id: '...'},\n oneTimeOrders: [\n {\n _embedded: {property1: {}, property2: {}},\n company: {},\n currency: '...',\n endDate: 12345,\n endOfDiscountDate: 12345,\n frequency: '...',\n id: 12345,\n links: [{}, {}],\n nextBillingDate: 12345,\n paymentPlan: {},\n referenceCode: '...',\n salesSupportUser: {},\n startDate: 12345,\n status: '...',\n totalPrice: 12345,\n type: '...',\n user: {}\n },\n {\n _embedded: {property1: {}, property2: {}},\n company: {},\n currency: '...',\n endDate: 12345,\n endOfDiscountDate: 12345,\n frequency: '...',\n id: 12345,\n links: [{}, {}],\n nextBillingDate: 12345,\n paymentPlan: {},\n referenceCode: '...',\n salesSupportUser: {},\n startDate: 12345,\n status: '...',\n totalPrice: 12345,\n type: '...',\n user: {}\n }\n ],\n orderLines: [{}, {}],\n parameters: [{name: '...', value: '...'}, {name: '...', value: '...'}],\n paymentPlan: {\n allowCustomUsage: true,\n contract: {},\n cost: [{}, {}],\n discount: {},\n frequency: '...',\n href: '...',\n id: 12345,\n isPrimaryPrice: true,\n keepBillDateOnUsageChange: true,\n primaryPrice: true,\n separatePrepaid: true,\n tld: '...',\n uuid: '...'\n },\n paymentPlanId: 12345,\n previousOrder: {href: '...', id: '...'},\n referenceCode: '...',\n salesSupportUser: {href: '...', id: '...'},\n startDate: 12345,\n status: '...',\n totalPrice: 12345,\n type: '...',\n user: {href: '...', id: '...'}\n },\n product: {href: '...', id: '...'},\n redirectUrl: '...',\n status: '...',\n upcomingOrder: {\n _embedded: {property1: {}, property2: {}},\n activated: true,\n company: {href: '...', id: '...'},\n contract: {},\n currency: '...',\n customAttributes: [\n {attributeType: 'TEXT', name: '...', value: '...', valueKeys: ['...', '...']},\n {attributeType: 'TEXT', name: '...', value: '...', valueKeys: ['...', '...']}\n ],\n discount: {href: '...', id: '...'},\n discountId: 12345,\n endDate: 12345,\n endOfDiscountDate: 12345,\n frequency: '...',\n id: 12345,\n links: [{href: '...', rel: '...'}, {href: '...', rel: '...'}],\n nextBillingDate: 12345,\n nextOrder: {href: '...', id: '...'},\n oneTimeOrders: [\n {\n _embedded: {property1: {}, property2: {}},\n company: {},\n currency: '...',\n endDate: 12345,\n endOfDiscountDate: 12345,\n frequency: '...',\n id: 12345,\n links: [{}, {}],\n nextBillingDate: 12345,\n paymentPlan: {},\n referenceCode: '...',\n salesSupportUser: {},\n startDate: 12345,\n status: '...',\n totalPrice: 12345,\n type: '...',\n user: {}\n },\n {\n _embedded: {property1: {}, property2: {}},\n company: {},\n currency: '...',\n endDate: 12345,\n endOfDiscountDate: 12345,\n frequency: '...',\n id: 12345,\n links: [{}, {}],\n nextBillingDate: 12345,\n paymentPlan: {},\n referenceCode: '...',\n salesSupportUser: {},\n startDate: 12345,\n status: '...',\n totalPrice: 12345,\n type: '...',\n user: {}\n }\n ],\n orderLines: [{}, {}],\n parameters: [{name: '...', value: '...'}, {name: '...', value: '...'}],\n paymentPlan: {\n allowCustomUsage: true,\n contract: {},\n cost: [{}, {}],\n discount: {},\n frequency: '...',\n href: '...',\n id: 12345,\n isPrimaryPrice: true,\n keepBillDateOnUsageChange: true,\n primaryPrice: true,\n separatePrepaid: true,\n tld: '...',\n uuid: '...'\n },\n paymentPlanId: 12345,\n previousOrder: {href: '...', id: '...'},\n referenceCode: '...',\n salesSupportUser: {href: '...', id: '...'},\n startDate: 12345,\n status: '...',\n totalPrice: 12345,\n type: '...',\n user: {href: '...', id: '...'}\n },\n user: {href: '...', id: '...'}\n },\n json: true\n};\n\nrequest(options, function (error, response, body) {\n if (error) throw new Error(error);\n\n console.log(body);\n});\n" - lang: Java + Okhttp source: "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"assignedUsers\\\":12345,\\\"bundleApplicationId\\\":12345,\\\"company\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"},\\\"creationDate\\\":12345,\\\"edition\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"},\\\"endDate\\\":12345,\\\"externalAccountId\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\",\\\"internalId\\\":\\\"...\\\",\\\"maxUsers\\\":12345,\\\"order\\\":{\\\"_embedded\\\":{\\\"property1\\\":{},\\\"property2\\\":{}},\\\"activated\\\":true,\\\"company\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"},\\\"contract\\\":{\\\"minimumServiceLength\\\":24,\\\"endOfContractDate\\\":123451232,\\\"gracePeriodEndDate\\\":null,\\\"cancellationPeriodLimit\\\":null,\\\"endOfContractGracePeriod\\\":null,\\\"terminationFee\\\":{\\\"type\\\":\\\"PERCENTAGE\\\",\\\"description\\\":\\\"Fee\\\",\\\"percentage\\\":100,\\\"price\\\":null,\\\"estimatedCost\\\":324.56},\\\"renewal\\\":null},\\\"currency\\\":\\\"...\\\",\\\"customAttributes\\\":[{\\\"attributeType\\\":\\\"TEXT\\\",\\\"name\\\":\\\"...\\\",\\\"value\\\":\\\"...\\\",\\\"valueKeys\\\":[\\\"...\\\",\\\"...\\\"]},{\\\"attributeType\\\":\\\"TEXT\\\",\\\"name\\\":\\\"...\\\",\\\"value\\\":\\\"...\\\",\\\"valueKeys\\\":[\\\"...\\\",\\\"...\\\"]}],\\\"discount\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"},\\\"discountId\\\":12345,\\\"endDate\\\":12345,\\\"endOfDiscountDate\\\":12345,\\\"frequency\\\":\\\"...\\\",\\\"id\\\":12345,\\\"links\\\":[{\\\"href\\\":\\\"...\\\",\\\"rel\\\":\\\"...\\\"},{\\\"href\\\":\\\"...\\\",\\\"rel\\\":\\\"...\\\"}],\\\"nextBillingDate\\\":12345,\\\"nextOrder\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"},\\\"oneTimeOrders\\\":[{\\\"_embedded\\\":{\\\"property1\\\":{},\\\"property2\\\":{}},\\\"company\\\":{},\\\"currency\\\":\\\"...\\\",\\\"endDate\\\":12345,\\\"endOfDiscountDate\\\":12345,\\\"frequency\\\":\\\"...\\\",\\\"id\\\":12345,\\\"links\\\":[{},{}],\\\"nextBillingDate\\\":12345,\\\"paymentPlan\\\":{},\\\"referenceCode\\\":\\\"...\\\",\\\"salesSupportUser\\\":{},\\\"startDate\\\":12345,\\\"status\\\":\\\"...\\\",\\\"totalPrice\\\":12345,\\\"type\\\":\\\"...\\\",\\\"user\\\":{}},{\\\"_embedded\\\":{\\\"property1\\\":{},\\\"property2\\\":{}},\\\"company\\\":{},\\\"currency\\\":\\\"...\\\",\\\"endDate\\\":12345,\\\"endOfDiscountDate\\\":12345,\\\"frequency\\\":\\\"...\\\",\\\"id\\\":12345,\\\"links\\\":[{},{}],\\\"nextBillingDate\\\":12345,\\\"paymentPlan\\\":{},\\\"referenceCode\\\":\\\"...\\\",\\\"salesSupportUser\\\":{},\\\"startDate\\\":12345,\\\"status\\\":\\\"...\\\",\\\"totalPrice\\\":12345,\\\"type\\\":\\\"...\\\",\\\"user\\\":{}}],\\\"orderLines\\\":[{},{}],\\\"parameters\\\":[{\\\"name\\\":\\\"...\\\",\\\"value\\\":\\\"...\\\"},{\\\"name\\\":\\\"...\\\",\\\"value\\\":\\\"...\\\"}],\\\"paymentPlan\\\":{\\\"allowCustomUsage\\\":true,\\\"contract\\\":{},\\\"cost\\\":[{},{}],\\\"discount\\\":{},\\\"frequency\\\":\\\"...\\\",\\\"href\\\":\\\"...\\\",\\\"id\\\":12345,\\\"isPrimaryPrice\\\":true,\\\"keepBillDateOnUsageChange\\\":true,\\\"primaryPrice\\\":true,\\\"separatePrepaid\\\":true,\\\"tld\\\":\\\"...\\\",\\\"uuid\\\":\\\"...\\\"},\\\"paymentPlanId\\\":12345,\\\"previousOrder\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"},\\\"referenceCode\\\":\\\"...\\\",\\\"salesSupportUser\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"},\\\"startDate\\\":12345,\\\"status\\\":\\\"...\\\",\\\"totalPrice\\\":12345,\\\"type\\\":\\\"...\\\",\\\"user\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"}},\\\"product\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"},\\\"redirectUrl\\\":\\\"...\\\",\\\"status\\\":\\\"...\\\",\\\"upcomingOrder\\\":{\\\"_embedded\\\":{\\\"property1\\\":{},\\\"property2\\\":{}},\\\"activated\\\":true,\\\"company\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"},\\\"contract\\\":{},\\\"currency\\\":\\\"...\\\",\\\"customAttributes\\\":[{\\\"attributeType\\\":\\\"TEXT\\\",\\\"name\\\":\\\"...\\\",\\\"value\\\":\\\"...\\\",\\\"valueKeys\\\":[\\\"...\\\",\\\"...\\\"]},{\\\"attributeType\\\":\\\"TEXT\\\",\\\"name\\\":\\\"...\\\",\\\"value\\\":\\\"...\\\",\\\"valueKeys\\\":[\\\"...\\\",\\\"...\\\"]}],\\\"discount\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"},\\\"discountId\\\":12345,\\\"endDate\\\":12345,\\\"endOfDiscountDate\\\":12345,\\\"frequency\\\":\\\"...\\\",\\\"id\\\":12345,\\\"links\\\":[{\\\"href\\\":\\\"...\\\",\\\"rel\\\":\\\"...\\\"},{\\\"href\\\":\\\"...\\\",\\\"rel\\\":\\\"...\\\"}],\\\"nextBillingDate\\\":12345,\\\"nextOrder\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"},\\\"oneTimeOrders\\\":[{\\\"_embedded\\\":{\\\"property1\\\":{},\\\"property2\\\":{}},\\\"company\\\":{},\\\"currency\\\":\\\"...\\\",\\\"endDate\\\":12345,\\\"endOfDiscountDate\\\":12345,\\\"frequency\\\":\\\"...\\\",\\\"id\\\":12345,\\\"links\\\":[{},{}],\\\"nextBillingDate\\\":12345,\\\"paymentPlan\\\":{},\\\"referenceCode\\\":\\\"...\\\",\\\"salesSupportUser\\\":{},\\\"startDate\\\":12345,\\\"status\\\":\\\"...\\\",\\\"totalPrice\\\":12345,\\\"type\\\":\\\"...\\\",\\\"user\\\":{}},{\\\"_embedded\\\":{\\\"property1\\\":{},\\\"property2\\\":{}},\\\"company\\\":{},\\\"currency\\\":\\\"...\\\",\\\"endDate\\\":12345,\\\"endOfDiscountDate\\\":12345,\\\"frequency\\\":\\\"...\\\",\\\"id\\\":12345,\\\"links\\\":[{},{}],\\\"nextBillingDate\\\":12345,\\\"paymentPlan\\\":{},\\\"referenceCode\\\":\\\"...\\\",\\\"salesSupportUser\\\":{},\\\"startDate\\\":12345,\\\"status\\\":\\\"...\\\",\\\"totalPrice\\\":12345,\\\"type\\\":\\\"...\\\",\\\"user\\\":{}}],\\\"orderLines\\\":[{},{}],\\\"parameters\\\":[{\\\"name\\\":\\\"...\\\",\\\"value\\\":\\\"...\\\"},{\\\"name\\\":\\\"...\\\",\\\"value\\\":\\\"...\\\"}],\\\"paymentPlan\\\":{\\\"allowCustomUsage\\\":true,\\\"contract\\\":{},\\\"cost\\\":[{},{}],\\\"discount\\\":{},\\\"frequency\\\":\\\"...\\\",\\\"href\\\":\\\"...\\\",\\\"id\\\":12345,\\\"isPrimaryPrice\\\":true,\\\"keepBillDateOnUsageChange\\\":true,\\\"primaryPrice\\\":true,\\\"separatePrepaid\\\":true,\\\"tld\\\":\\\"...\\\",\\\"uuid\\\":\\\"...\\\"},\\\"paymentPlanId\\\":12345,\\\"previousOrder\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"},\\\"referenceCode\\\":\\\"...\\\",\\\"salesSupportUser\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"},\\\"startDate\\\":12345,\\\"status\\\":\\\"...\\\",\\\"totalPrice\\\":12345,\\\"type\\\":\\\"...\\\",\\\"user\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"}},\\\"user\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"}}\");\nRequest request = new Request.Builder()\n .url(\"https://marketplace.appdirect.com/api/billing/v1/companies/%7BcompanyId%7D/users/%7BuserId%7D/subscriptions?sendNotification=SOME_BOOLEAN_VALUE\")\n .post(body)\n .build();\n\nResponse response = client.newCall(request).execute();" /billing/v1/companies/{companyId}/users/{userId}/subscriptions/{subscriptionId}/preview: put: description: Preview the changes for the given subscription using the provided data tags: - Subscriptions summary: Preview changed subscription details operationId: resource_Other_previewChangeSubscription_PUT parameters: - description: User's company ID name: companyId in: path required: true schema: type: string - description: Subscription ID name: subscriptionId in: path required: true schema: type: string - description: User ID name: userId in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SubscriptionWS' application/xml: schema: $ref: '#/components/schemas/SubscriptionWS' description: Subscription data object responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SubscriptionWS' examples: response: value: id: 1b577640-9b77-47bc-beb8-ed59accb4836 creationDate: 1481002406580 endDate: null externalAccountId: d2f4acf1-fb5a-4c4a-921f-75c4b6bfff08 status: ACTIVE maxUsers: 1 assignedUsers: 1 order: startDate: 1480921200000 endDate: null nextBillingDate: 1483599600000 endOfDiscountDate: null status: PENDING_REMOTE_CREATION frequency: MONTHLY currency: USD type: MIGRATION totalPrice: 100 user: null salesSupportUser: null company: null referenceCode: null paymentPlan: href: http://appdirect/api/marketplace/v1/products/2/editions/2/paymentPlans/2 id: 2 uuid: eaca1aa5-4c4f-44cb-8cf4-eb0aa9267273 frequency: MONTHLY contract: minimumServiceLength: null cancellationPeriodLimit: null endOfContractGracePeriod: null blockSwitchToShorterContract: false blockContractDowngrades: false blockContractUpgrades: false alignWithParentCycleStartDate: false gracePeriod: null terminationFee: null autoExtensionPricingId: null allowCustomUsage: false keepBillDateOnUsageChange: false separatePrepaid: false isPrimaryPrice: false costs: - id: 2 unit: USER unitDependency: null minUnits: 0 maxUnits: null meteredUsage: false increment: 1 pricePerIncrement: false blockContractDecrease: false blockContractIncrease: false blockOriginalContractDecrease: false amount: USD: 10 pricingStrategy: UNIT discount: null primaryPrice: false contract: null previousOrder: null nextOrder: null discount: null paymentPlanId: 2 discountId: null activated: false oneTimeOrders: - startDate: 1480921200000 endDate: 1483599600000 nextBillingDate: 1483599600000 endOfDiscountDate: null status: INITIALIZED frequency: MONTHLY currency: USD type: CREDIT totalPrice: -10 user: null salesSupportUser: null company: null referenceCode: null paymentPlan: id: '2' href: http://appdirect/api/marketplace/v1/products/2/editions/2/paymentPlans/2 links: [] id: null orderLines: - type: ITEM unit: USER quantity: 10 price: 10 listingPrice: 10 totalPrice: 100 description: Test App 1 - null - Per User Fee parameters: [] links: - rel: subscription href: http://appdirect/api/billing/v1/subscriptions/1b577640-9b77-47bc-beb8-ed59accb4836 id: null upcomingOrder: null user: null company: null product: null edition: null redirectUrl: null application/xml: schema: $ref: '#/components/schemas/SubscriptionWS' '400': description: Bad Request '404': description: Not Found x-codeSamples: - lang: Shell + Curl source: "curl --request PUT \\\n --url https://marketplace.appdirect.com/api/billing/v1/companies/%7BcompanyId%7D/users/%7BuserId%7D/subscriptions/%7BsubscriptionId%7D/preview \\\n --data '{\"assignedUsers\":12345,\"bundleApplicationId\":12345,\"company\":{\"href\":\"...\",\"id\":\"...\"},\"creationDate\":12345,\"edition\":{\"href\":\"...\",\"id\":\"...\"},\"endDate\":12345,\"externalAccountId\":\"...\",\"id\":\"...\",\"internalId\":\"...\",\"maxUsers\":12345,\"order\":{\"_embedded\":{\"property1\":{},\"property2\":{}},\"activated\":true,\"company\":{\"href\":\"...\",\"id\":\"...\"},\"contract\":{\"minimumServiceLength\":24,\"endOfContractDate\":123451232,\"gracePeriodEndDate\":null,\"cancellationPeriodLimit\":null,\"endOfContractGracePeriod\":null,\"terminationFee\":{\"type\":\"PERCENTAGE\",\"description\":\"Fee\",\"percentage\":100,\"price\":null,\"estimatedCost\":324.56},\"renewal\":null},\"currency\":\"...\",\"customAttributes\":[{\"attributeType\":\"TEXT\",\"name\":\"...\",\"value\":\"...\",\"valueKeys\":[\"...\",\"...\"]},{\"attributeType\":\"TEXT\",\"name\":\"...\",\"value\":\"...\",\"valueKeys\":[\"...\",\"...\"]}],\"discount\":{\"href\":\"...\",\"id\":\"...\"},\"discountId\":12345,\"endDate\":12345,\"endOfDiscountDate\":12345,\"frequency\":\"...\",\"id\":12345,\"links\":[{\"href\":\"...\",\"rel\":\"...\"},{\"href\":\"...\",\"rel\":\"...\"}],\"nextBillingDate\":12345,\"nextOrder\":{\"href\":\"...\",\"id\":\"...\"},\"oneTimeOrders\":[{\"_embedded\":{\"property1\":{},\"property2\":{}},\"company\":{},\"currency\":\"...\",\"endDate\":12345,\"endOfDiscountDate\":12345,\"frequency\":\"...\",\"id\":12345,\"links\":[{},{}],\"nextBillingDate\":12345,\"paymentPlan\":{},\"referenceCode\":\"...\",\"salesSupportUser\":{},\"startDate\":12345,\"status\":\"...\",\"totalPrice\":12345,\"type\":\"...\",\"user\":{}},{\"_embedded\":{\"property1\":{},\"property2\":{}},\"company\":{},\"currency\":\"...\",\"endDate\":12345,\"endOfDiscountDate\":12345,\"frequency\":\"...\",\"id\":12345,\"links\":[{},{}],\"nextBillingDate\":12345,\"paymentPlan\":{},\"referenceCode\":\"...\",\"salesSupportUser\":{},\"startDate\":12345,\"status\":\"...\",\"totalPrice\":12345,\"type\":\"...\",\"user\":{}}],\"orderLines\":[{},{}],\"parameters\":[{\"name\":\"...\",\"value\":\"...\"},{\"name\":\"...\",\"value\":\"...\"}],\"paymentPlan\":{\"allowCustomUsage\":true,\"contract\":{},\"cost\":[{},{}],\"discount\":{},\"frequency\":\"...\",\"href\":\"...\",\"id\":12345,\"isPrimaryPrice\":true,\"keepBillDateOnUsageChange\":true,\"primaryPrice\":true,\"separatePrepaid\":true,\"tld\":\"...\",\"uuid\":\"...\"},\"paymentPlanId\":12345,\"previousOrder\":{\"href\":\"...\",\"id\":\"...\"},\"referenceCode\":\"...\",\"salesSupportUser\":{\"href\":\"...\",\"id\":\"...\"},\"startDate\":12345,\"status\":\"...\",\"totalPrice\":12345,\"type\":\"...\",\"user\":{\"href\":\"...\",\"id\":\"...\"}},\"product\":{\"href\":\"...\",\"id\":\"...\"},\"redirectUrl\":\"...\",\"status\":\"...\",\"upcomingOrder\":{\"_embedded\":{\"property1\":{},\"property2\":{}},\"activated\":true,\"company\":{\"href\":\"...\",\"id\":\"...\"},\"contract\":{},\"currency\":\"...\",\"customAttributes\":[{\"attributeType\":\"TEXT\",\"name\":\"...\",\"value\":\"...\",\"valueKeys\":[\"...\",\"...\"]},{\"attributeType\":\"TEXT\",\"name\":\"...\",\"value\":\"...\",\"valueKeys\":[\"...\",\"...\"]}],\"discount\":{\"href\":\"...\",\"id\":\"...\"},\"discountId\":12345,\"endDate\":12345,\"endOfDiscountDate\":12345,\"frequency\":\"...\",\"id\":12345,\"links\":[{\"href\":\"...\",\"rel\":\"...\"},{\"href\":\"...\",\"rel\":\"...\"}],\"nextBillingDate\":12345,\"nextOrder\":{\"href\":\"...\",\"id\":\"...\"},\"oneTimeOrders\":[{\"_embedded\":{\"property1\":{},\"property2\":{}},\"company\":{},\"currency\":\"...\",\"endDate\":12345,\"endOfDiscountDate\":12345,\"frequency\":\"...\",\"id\":12345,\"links\":[{},{}],\"nextBillingDate\":12345,\"paymentPlan\":{},\"referenceCode\":\"...\",\"salesSupportUser\":{},\"startDate\":12345,\"status\":\"...\",\"totalPrice\":12345,\"type\":\"...\",\"user\":{}},{\"_embedded\":{\"property1\":{},\"property2\":{}},\"company\":{},\"currency\":\"...\",\"endDate\":12345,\"endOfDiscountDate\":12345,\"frequency\":\"...\",\"id\":12345,\"links\":[{},{}],\"nextBillingDate\":12345,\"paymentPlan\":{},\"referenceCode\":\"...\",\"salesSupportUser\":{},\"startDate\":12345,\"status\":\"...\",\"totalPrice\":12345,\"type\":\"...\",\"user\":{}}],\"orderLines\":[{},{}],\"parameters\":[{\"name\":\"...\",\"value\":\"...\"},{\"name\":\"...\",\"value\":\"...\"}],\"paymentPlan\":{\"allowCustomUsage\":true,\"contract\":{},\"cost\":[{},{}],\"discount\":{},\"frequency\":\"...\",\"href\":\"...\",\"id\":12345,\"isPrimaryPrice\":true,\"keepBillDateOnUsageChange\":true,\"primaryPrice\":true,\"separatePrepaid\":true,\"tld\":\"...\",\"uuid\":\"...\"},\"paymentPlanId\":12345,\"previousOrder\":{\"href\":\"...\",\"id\":\"...\"},\"referenceCode\":\"...\",\"salesSupportUser\":{\"href\":\"...\",\"id\":\"...\"},\"startDate\":12345,\"status\":\"...\",\"totalPrice\":12345,\"type\":\"...\",\"user\":{\"href\":\"...\",\"id\":\"...\"}},\"user\":{\"href\":\"...\",\"id\":\"...\"}}'" - lang: Node + Request source: "const request = require('request');\n\nconst options = {\n method: 'PUT',\n url: 'https://marketplace.appdirect.com/api/billing/v1/companies/%7BcompanyId%7D/users/%7BuserId%7D/subscriptions/%7BsubscriptionId%7D/preview',\n body: {\n assignedUsers: 12345,\n bundleApplicationId: 12345,\n company: {href: '...', id: '...'},\n creationDate: 12345,\n edition: {href: '...', id: '...'},\n endDate: 12345,\n externalAccountId: '...',\n id: '...',\n internalId: '...',\n maxUsers: 12345,\n order: {\n _embedded: {property1: {}, property2: {}},\n activated: true,\n company: {href: '...', id: '...'},\n contract: {\n minimumServiceLength: 24,\n endOfContractDate: 123451232,\n gracePeriodEndDate: null,\n cancellationPeriodLimit: null,\n endOfContractGracePeriod: null,\n terminationFee: {\n type: 'PERCENTAGE',\n description: 'Fee',\n percentage: 100,\n price: null,\n estimatedCost: 324.56\n },\n renewal: null\n },\n currency: '...',\n customAttributes: [\n {attributeType: 'TEXT', name: '...', value: '...', valueKeys: ['...', '...']},\n {attributeType: 'TEXT', name: '...', value: '...', valueKeys: ['...', '...']}\n ],\n discount: {href: '...', id: '...'},\n discountId: 12345,\n endDate: 12345,\n endOfDiscountDate: 12345,\n frequency: '...',\n id: 12345,\n links: [{href: '...', rel: '...'}, {href: '...', rel: '...'}],\n nextBillingDate: 12345,\n nextOrder: {href: '...', id: '...'},\n oneTimeOrders: [\n {\n _embedded: {property1: {}, property2: {}},\n company: {},\n currency: '...',\n endDate: 12345,\n endOfDiscountDate: 12345,\n frequency: '...',\n id: 12345,\n links: [{}, {}],\n nextBillingDate: 12345,\n paymentPlan: {},\n referenceCode: '...',\n salesSupportUser: {},\n startDate: 12345,\n status: '...',\n totalPrice: 12345,\n type: '...',\n user: {}\n },\n {\n _embedded: {property1: {}, property2: {}},\n company: {},\n currency: '...',\n endDate: 12345,\n endOfDiscountDate: 12345,\n frequency: '...',\n id: 12345,\n links: [{}, {}],\n nextBillingDate: 12345,\n paymentPlan: {},\n referenceCode: '...',\n salesSupportUser: {},\n startDate: 12345,\n status: '...',\n totalPrice: 12345,\n type: '...',\n user: {}\n }\n ],\n orderLines: [{}, {}],\n parameters: [{name: '...', value: '...'}, {name: '...', value: '...'}],\n paymentPlan: {\n allowCustomUsage: true,\n contract: {},\n cost: [{}, {}],\n discount: {},\n frequency: '...',\n href: '...',\n id: 12345,\n isPrimaryPrice: true,\n keepBillDateOnUsageChange: true,\n primaryPrice: true,\n separatePrepaid: true,\n tld: '...',\n uuid: '...'\n },\n paymentPlanId: 12345,\n previousOrder: {href: '...', id: '...'},\n referenceCode: '...',\n salesSupportUser: {href: '...', id: '...'},\n startDate: 12345,\n status: '...',\n totalPrice: 12345,\n type: '...',\n user: {href: '...', id: '...'}\n },\n product: {href: '...', id: '...'},\n redirectUrl: '...',\n status: '...',\n upcomingOrder: {\n _embedded: {property1: {}, property2: {}},\n activated: true,\n company: {href: '...', id: '...'},\n contract: {},\n currency: '...',\n customAttributes: [\n {attributeType: 'TEXT', name: '...', value: '...', valueKeys: ['...', '...']},\n {attributeType: 'TEXT', name: '...', value: '...', valueKeys: ['...', '...']}\n ],\n discount: {href: '...', id: '...'},\n discountId: 12345,\n endDate: 12345,\n endOfDiscountDate: 12345,\n frequency: '...',\n id: 12345,\n links: [{href: '...', rel: '...'}, {href: '...', rel: '...'}],\n nextBillingDate: 12345,\n nextOrder: {href: '...', id: '...'},\n oneTimeOrders: [\n {\n _embedded: {property1: {}, property2: {}},\n company: {},\n currency: '...',\n endDate: 12345,\n endOfDiscountDate: 12345,\n frequency: '...',\n id: 12345,\n links: [{}, {}],\n nextBillingDate: 12345,\n paymentPlan: {},\n referenceCode: '...',\n salesSupportUser: {},\n startDate: 12345,\n status: '...',\n totalPrice: 12345,\n type: '...',\n user: {}\n },\n {\n _embedded: {property1: {}, property2: {}},\n company: {},\n currency: '...',\n endDate: 12345,\n endOfDiscountDate: 12345,\n frequency: '...',\n id: 12345,\n links: [{}, {}],\n nextBillingDate: 12345,\n paymentPlan: {},\n referenceCode: '...',\n salesSupportUser: {},\n startDate: 12345,\n status: '...',\n totalPrice: 12345,\n type: '...',\n user: {}\n }\n ],\n orderLines: [{}, {}],\n parameters: [{name: '...', value: '...'}, {name: '...', value: '...'}],\n paymentPlan: {\n allowCustomUsage: true,\n contract: {},\n cost: [{}, {}],\n discount: {},\n frequency: '...',\n href: '...',\n id: 12345,\n isPrimaryPrice: true,\n keepBillDateOnUsageChange: true,\n primaryPrice: true,\n separatePrepaid: true,\n tld: '...',\n uuid: '...'\n },\n paymentPlanId: 12345,\n previousOrder: {href: '...', id: '...'},\n referenceCode: '...',\n salesSupportUser: {href: '...', id: '...'},\n startDate: 12345,\n status: '...',\n totalPrice: 12345,\n type: '...',\n user: {href: '...', id: '...'}\n },\n user: {href: '...', id: '...'}\n },\n json: true\n};\n\nrequest(options, function (error, response, body) {\n if (error) throw new Error(error);\n\n console.log(body);\n});\n" - lang: Java + Okhttp source: "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"assignedUsers\\\":12345,\\\"bundleApplicationId\\\":12345,\\\"company\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"},\\\"creationDate\\\":12345,\\\"edition\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"},\\\"endDate\\\":12345,\\\"externalAccountId\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\",\\\"internalId\\\":\\\"...\\\",\\\"maxUsers\\\":12345,\\\"order\\\":{\\\"_embedded\\\":{\\\"property1\\\":{},\\\"property2\\\":{}},\\\"activated\\\":true,\\\"company\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"},\\\"contract\\\":{\\\"minimumServiceLength\\\":24,\\\"endOfContractDate\\\":123451232,\\\"gracePeriodEndDate\\\":null,\\\"cancellationPeriodLimit\\\":null,\\\"endOfContractGracePeriod\\\":null,\\\"terminationFee\\\":{\\\"type\\\":\\\"PERCENTAGE\\\",\\\"description\\\":\\\"Fee\\\",\\\"percentage\\\":100,\\\"price\\\":null,\\\"estimatedCost\\\":324.56},\\\"renewal\\\":null},\\\"currency\\\":\\\"...\\\",\\\"customAttributes\\\":[{\\\"attributeType\\\":\\\"TEXT\\\",\\\"name\\\":\\\"...\\\",\\\"value\\\":\\\"...\\\",\\\"valueKeys\\\":[\\\"...\\\",\\\"...\\\"]},{\\\"attributeType\\\":\\\"TEXT\\\",\\\"name\\\":\\\"...\\\",\\\"value\\\":\\\"...\\\",\\\"valueKeys\\\":[\\\"...\\\",\\\"...\\\"]}],\\\"discount\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"},\\\"discountId\\\":12345,\\\"endDate\\\":12345,\\\"endOfDiscountDate\\\":12345,\\\"frequency\\\":\\\"...\\\",\\\"id\\\":12345,\\\"links\\\":[{\\\"href\\\":\\\"...\\\",\\\"rel\\\":\\\"...\\\"},{\\\"href\\\":\\\"...\\\",\\\"rel\\\":\\\"...\\\"}],\\\"nextBillingDate\\\":12345,\\\"nextOrder\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"},\\\"oneTimeOrders\\\":[{\\\"_embedded\\\":{\\\"property1\\\":{},\\\"property2\\\":{}},\\\"company\\\":{},\\\"currency\\\":\\\"...\\\",\\\"endDate\\\":12345,\\\"endOfDiscountDate\\\":12345,\\\"frequency\\\":\\\"...\\\",\\\"id\\\":12345,\\\"links\\\":[{},{}],\\\"nextBillingDate\\\":12345,\\\"paymentPlan\\\":{},\\\"referenceCode\\\":\\\"...\\\",\\\"salesSupportUser\\\":{},\\\"startDate\\\":12345,\\\"status\\\":\\\"...\\\",\\\"totalPrice\\\":12345,\\\"type\\\":\\\"...\\\",\\\"user\\\":{}},{\\\"_embedded\\\":{\\\"property1\\\":{},\\\"property2\\\":{}},\\\"company\\\":{},\\\"currency\\\":\\\"...\\\",\\\"endDate\\\":12345,\\\"endOfDiscountDate\\\":12345,\\\"frequency\\\":\\\"...\\\",\\\"id\\\":12345,\\\"links\\\":[{},{}],\\\"nextBillingDate\\\":12345,\\\"paymentPlan\\\":{},\\\"referenceCode\\\":\\\"...\\\",\\\"salesSupportUser\\\":{},\\\"startDate\\\":12345,\\\"status\\\":\\\"...\\\",\\\"totalPrice\\\":12345,\\\"type\\\":\\\"...\\\",\\\"user\\\":{}}],\\\"orderLines\\\":[{},{}],\\\"parameters\\\":[{\\\"name\\\":\\\"...\\\",\\\"value\\\":\\\"...\\\"},{\\\"name\\\":\\\"...\\\",\\\"value\\\":\\\"...\\\"}],\\\"paymentPlan\\\":{\\\"allowCustomUsage\\\":true,\\\"contract\\\":{},\\\"cost\\\":[{},{}],\\\"discount\\\":{},\\\"frequency\\\":\\\"...\\\",\\\"href\\\":\\\"...\\\",\\\"id\\\":12345,\\\"isPrimaryPrice\\\":true,\\\"keepBillDateOnUsageChange\\\":true,\\\"primaryPrice\\\":true,\\\"separatePrepaid\\\":true,\\\"tld\\\":\\\"...\\\",\\\"uuid\\\":\\\"...\\\"},\\\"paymentPlanId\\\":12345,\\\"previousOrder\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"},\\\"referenceCode\\\":\\\"...\\\",\\\"salesSupportUser\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"},\\\"startDate\\\":12345,\\\"status\\\":\\\"...\\\",\\\"totalPrice\\\":12345,\\\"type\\\":\\\"...\\\",\\\"user\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"}},\\\"product\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"},\\\"redirectUrl\\\":\\\"...\\\",\\\"status\\\":\\\"...\\\",\\\"upcomingOrder\\\":{\\\"_embedded\\\":{\\\"property1\\\":{},\\\"property2\\\":{}},\\\"activated\\\":true,\\\"company\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"},\\\"contract\\\":{},\\\"currency\\\":\\\"...\\\",\\\"customAttributes\\\":[{\\\"attributeType\\\":\\\"TEXT\\\",\\\"name\\\":\\\"...\\\",\\\"value\\\":\\\"...\\\",\\\"valueKeys\\\":[\\\"...\\\",\\\"...\\\"]},{\\\"attributeType\\\":\\\"TEXT\\\",\\\"name\\\":\\\"...\\\",\\\"value\\\":\\\"...\\\",\\\"valueKeys\\\":[\\\"...\\\",\\\"...\\\"]}],\\\"discount\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"},\\\"discountId\\\":12345,\\\"endDate\\\":12345,\\\"endOfDiscountDate\\\":12345,\\\"frequency\\\":\\\"...\\\",\\\"id\\\":12345,\\\"links\\\":[{\\\"href\\\":\\\"...\\\",\\\"rel\\\":\\\"...\\\"},{\\\"href\\\":\\\"...\\\",\\\"rel\\\":\\\"...\\\"}],\\\"nextBillingDate\\\":12345,\\\"nextOrder\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"},\\\"oneTimeOrders\\\":[{\\\"_embedded\\\":{\\\"property1\\\":{},\\\"property2\\\":{}},\\\"company\\\":{},\\\"currency\\\":\\\"...\\\",\\\"endDate\\\":12345,\\\"endOfDiscountDate\\\":12345,\\\"frequency\\\":\\\"...\\\",\\\"id\\\":12345,\\\"links\\\":[{},{}],\\\"nextBillingDate\\\":12345,\\\"paymentPlan\\\":{},\\\"referenceCode\\\":\\\"...\\\",\\\"salesSupportUser\\\":{},\\\"startDate\\\":12345,\\\"status\\\":\\\"...\\\",\\\"totalPrice\\\":12345,\\\"type\\\":\\\"...\\\",\\\"user\\\":{}},{\\\"_embedded\\\":{\\\"property1\\\":{},\\\"property2\\\":{}},\\\"company\\\":{},\\\"currency\\\":\\\"...\\\",\\\"endDate\\\":12345,\\\"endOfDiscountDate\\\":12345,\\\"frequency\\\":\\\"...\\\",\\\"id\\\":12345,\\\"links\\\":[{},{}],\\\"nextBillingDate\\\":12345,\\\"paymentPlan\\\":{},\\\"referenceCode\\\":\\\"...\\\",\\\"salesSupportUser\\\":{},\\\"startDate\\\":12345,\\\"status\\\":\\\"...\\\",\\\"totalPrice\\\":12345,\\\"type\\\":\\\"...\\\",\\\"user\\\":{}}],\\\"orderLines\\\":[{},{}],\\\"parameters\\\":[{\\\"name\\\":\\\"...\\\",\\\"value\\\":\\\"...\\\"},{\\\"name\\\":\\\"...\\\",\\\"value\\\":\\\"...\\\"}],\\\"paymentPlan\\\":{\\\"allowCustomUsage\\\":true,\\\"contract\\\":{},\\\"cost\\\":[{},{}],\\\"discount\\\":{},\\\"frequency\\\":\\\"...\\\",\\\"href\\\":\\\"...\\\",\\\"id\\\":12345,\\\"isPrimaryPrice\\\":true,\\\"keepBillDateOnUsageChange\\\":true,\\\"primaryPrice\\\":true,\\\"separatePrepaid\\\":true,\\\"tld\\\":\\\"...\\\",\\\"uuid\\\":\\\"...\\\"},\\\"paymentPlanId\\\":12345,\\\"previousOrder\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"},\\\"referenceCode\\\":\\\"...\\\",\\\"salesSupportUser\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"},\\\"startDate\\\":12345,\\\"status\\\":\\\"...\\\",\\\"totalPrice\\\":12345,\\\"type\\\":\\\"...\\\",\\\"user\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"}},\\\"user\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"}}\");\nRequest request = new Request.Builder()\n .url(\"https://marketplace.appdirect.com/api/billing/v1/companies/%7BcompanyId%7D/users/%7BuserId%7D/subscriptions/%7BsubscriptionId%7D/preview\")\n .put(body)\n .build();\n\nResponse response = client.newCall(request).execute();" /billing/v1/companies/{companyId}/users/{userId}/subscriptions/preview: post: description: Preview creating a subscription for the given user and company using the provided data tags: - Subscriptions summary: Preview create a subscription operationId: resource_Other_previewCreateSubscription_POST parameters: - description: User's company ID name: companyId in: path required: true schema: type: string - description: User ID name: userId in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SubscriptionWS' application/xml: schema: $ref: '#/components/schemas/SubscriptionWS' description: Subscription data object responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/SubscriptionWS' examples: response: value: id: null creationDate: null endDate: null externalAccountId: null status: null maxUsers: null assignedUsers: null order: startDate: 1480921200000 endDate: null nextBillingDate: 1483599600000 endOfDiscountDate: null status: PENDING_REMOTE_CREATION frequency: MONTHLY currency: USD type: NEW totalPrice: 10 user: null salesSupportUser: null company: null referenceCode: null paymentPlan: href: http://appdirect/api/marketplace/v1/products/2/editions/2/paymentPlans/2 id: 2 uuid: eaca1aa5-4c4f-44cb-8cf4-eb0aa9267273 frequency: MONTHLY contract: minimumServiceLength: null cancellationPeriodLimit: null endOfContractGracePeriod: null blockSwitchToShorterContract: false blockContractDowngrades: false blockContractUpgrades: false alignWithParentCycleStartDate: false gracePeriod: null terminationFee: null autoExtensionPricingId: null allowCustomUsage: false keepBillDateOnUsageChange: false separatePrepaid: false isPrimaryPrice: false costs: - id: 2 unit: USER unitDependency: null minUnits: 0 maxUnits: null meteredUsage: false increment: 1 pricePerIncrement: false blockContractDecrease: false blockContractIncrease: false blockOriginalContractDecrease: false amount: USD: 10 pricingStrategy: UNIT discount: null primaryPrice: false contract: null previousOrder: null nextOrder: null discount: null paymentPlanId: 2 discountId: null activated: false oneTimeOrders: [] orderLines: - type: ITEM unit: USER quantity: 1 price: 10 listingPrice: 10 totalPrice: 10 description: Test App 1 - null - Per User Fee parameters: [] links: [] id: null upcomingOrder: null user: null company: null product: null edition: null redirectUrl: null application/xml: schema: $ref: '#/components/schemas/SubscriptionWS' '400': description: Bad Request '404': description: Not Found x-codeSamples: - lang: Shell + Curl source: "curl --request POST \\\n --url https://marketplace.appdirect.com/api/billing/v1/companies/%7BcompanyId%7D/users/%7BuserId%7D/subscriptions/preview \\\n --data '{\"assignedUsers\":12345,\"bundleApplicationId\":12345,\"company\":{\"href\":\"...\",\"id\":\"...\"},\"creationDate\":12345,\"edition\":{\"href\":\"...\",\"id\":\"...\"},\"endDate\":12345,\"externalAccountId\":\"...\",\"id\":\"...\",\"internalId\":\"...\",\"maxUsers\":12345,\"order\":{\"_embedded\":{\"property1\":{},\"property2\":{}},\"activated\":true,\"company\":{\"href\":\"...\",\"id\":\"...\"},\"contract\":{\"minimumServiceLength\":24,\"endOfContractDate\":123451232,\"gracePeriodEndDate\":null,\"cancellationPeriodLimit\":null,\"endOfContractGracePeriod\":null,\"terminationFee\":{\"type\":\"PERCENTAGE\",\"description\":\"Fee\",\"percentage\":100,\"price\":null,\"estimatedCost\":324.56},\"renewal\":null},\"currency\":\"...\",\"customAttributes\":[{\"attributeType\":\"TEXT\",\"name\":\"...\",\"value\":\"...\",\"valueKeys\":[\"...\",\"...\"]},{\"attributeType\":\"TEXT\",\"name\":\"...\",\"value\":\"...\",\"valueKeys\":[\"...\",\"...\"]}],\"discount\":{\"href\":\"...\",\"id\":\"...\"},\"discountId\":12345,\"endDate\":12345,\"endOfDiscountDate\":12345,\"frequency\":\"...\",\"id\":12345,\"links\":[{\"href\":\"...\",\"rel\":\"...\"},{\"href\":\"...\",\"rel\":\"...\"}],\"nextBillingDate\":12345,\"nextOrder\":{\"href\":\"...\",\"id\":\"...\"},\"oneTimeOrders\":[{\"_embedded\":{\"property1\":{},\"property2\":{}},\"company\":{},\"currency\":\"...\",\"endDate\":12345,\"endOfDiscountDate\":12345,\"frequency\":\"...\",\"id\":12345,\"links\":[{},{}],\"nextBillingDate\":12345,\"paymentPlan\":{},\"referenceCode\":\"...\",\"salesSupportUser\":{},\"startDate\":12345,\"status\":\"...\",\"totalPrice\":12345,\"type\":\"...\",\"user\":{}},{\"_embedded\":{\"property1\":{},\"property2\":{}},\"company\":{},\"currency\":\"...\",\"endDate\":12345,\"endOfDiscountDate\":12345,\"frequency\":\"...\",\"id\":12345,\"links\":[{},{}],\"nextBillingDate\":12345,\"paymentPlan\":{},\"referenceCode\":\"...\",\"salesSupportUser\":{},\"startDate\":12345,\"status\":\"...\",\"totalPrice\":12345,\"type\":\"...\",\"user\":{}}],\"orderLines\":[{},{}],\"parameters\":[{\"name\":\"...\",\"value\":\"...\"},{\"name\":\"...\",\"value\":\"...\"}],\"paymentPlan\":{\"allowCustomUsage\":true,\"contract\":{},\"cost\":[{},{}],\"discount\":{},\"frequency\":\"...\",\"href\":\"...\",\"id\":12345,\"isPrimaryPrice\":true,\"keepBillDateOnUsageChange\":true,\"primaryPrice\":true,\"separatePrepaid\":true,\"tld\":\"...\",\"uuid\":\"...\"},\"paymentPlanId\":12345,\"previousOrder\":{\"href\":\"...\",\"id\":\"...\"},\"referenceCode\":\"...\",\"salesSupportUser\":{\"href\":\"...\",\"id\":\"...\"},\"startDate\":12345,\"status\":\"...\",\"totalPrice\":12345,\"type\":\"...\",\"user\":{\"href\":\"...\",\"id\":\"...\"}},\"product\":{\"href\":\"...\",\"id\":\"...\"},\"redirectUrl\":\"...\",\"status\":\"...\",\"upcomingOrder\":{\"_embedded\":{\"property1\":{},\"property2\":{}},\"activated\":true,\"company\":{\"href\":\"...\",\"id\":\"...\"},\"contract\":{},\"currency\":\"...\",\"customAttributes\":[{\"attributeType\":\"TEXT\",\"name\":\"...\",\"value\":\"...\",\"valueKeys\":[\"...\",\"...\"]},{\"attributeType\":\"TEXT\",\"name\":\"...\",\"value\":\"...\",\"valueKeys\":[\"...\",\"...\"]}],\"discount\":{\"href\":\"...\",\"id\":\"...\"},\"discountId\":12345,\"endDate\":12345,\"endOfDiscountDate\":12345,\"frequency\":\"...\",\"id\":12345,\"links\":[{\"href\":\"...\",\"rel\":\"...\"},{\"href\":\"...\",\"rel\":\"...\"}],\"nextBillingDate\":12345,\"nextOrder\":{\"href\":\"...\",\"id\":\"...\"},\"oneTimeOrders\":[{\"_embedded\":{\"property1\":{},\"property2\":{}},\"company\":{},\"currency\":\"...\",\"endDate\":12345,\"endOfDiscountDate\":12345,\"frequency\":\"...\",\"id\":12345,\"links\":[{},{}],\"nextBillingDate\":12345,\"paymentPlan\":{},\"referenceCode\":\"...\",\"salesSupportUser\":{},\"startDate\":12345,\"status\":\"...\",\"totalPrice\":12345,\"type\":\"...\",\"user\":{}},{\"_embedded\":{\"property1\":{},\"property2\":{}},\"company\":{},\"currency\":\"...\",\"endDate\":12345,\"endOfDiscountDate\":12345,\"frequency\":\"...\",\"id\":12345,\"links\":[{},{}],\"nextBillingDate\":12345,\"paymentPlan\":{},\"referenceCode\":\"...\",\"salesSupportUser\":{},\"startDate\":12345,\"status\":\"...\",\"totalPrice\":12345,\"type\":\"...\",\"user\":{}}],\"orderLines\":[{},{}],\"parameters\":[{\"name\":\"...\",\"value\":\"...\"},{\"name\":\"...\",\"value\":\"...\"}],\"paymentPlan\":{\"allowCustomUsage\":true,\"contract\":{},\"cost\":[{},{}],\"discount\":{},\"frequency\":\"...\",\"href\":\"...\",\"id\":12345,\"isPrimaryPrice\":true,\"keepBillDateOnUsageChange\":true,\"primaryPrice\":true,\"separatePrepaid\":true,\"tld\":\"...\",\"uuid\":\"...\"},\"paymentPlanId\":12345,\"previousOrder\":{\"href\":\"...\",\"id\":\"...\"},\"referenceCode\":\"...\",\"salesSupportUser\":{\"href\":\"...\",\"id\":\"...\"},\"startDate\":12345,\"status\":\"...\",\"totalPrice\":12345,\"type\":\"...\",\"user\":{\"href\":\"...\",\"id\":\"...\"}},\"user\":{\"href\":\"...\",\"id\":\"...\"}}'" - lang: Node + Request source: "const request = require('request');\n\nconst options = {\n method: 'POST',\n url: 'https://marketplace.appdirect.com/api/billing/v1/companies/%7BcompanyId%7D/users/%7BuserId%7D/subscriptions/preview',\n body: {\n assignedUsers: 12345,\n bundleApplicationId: 12345,\n company: {href: '...', id: '...'},\n creationDate: 12345,\n edition: {href: '...', id: '...'},\n endDate: 12345,\n externalAccountId: '...',\n id: '...',\n internalId: '...',\n maxUsers: 12345,\n order: {\n _embedded: {property1: {}, property2: {}},\n activated: true,\n company: {href: '...', id: '...'},\n contract: {\n minimumServiceLength: 24,\n endOfContractDate: 123451232,\n gracePeriodEndDate: null,\n cancellationPeriodLimit: null,\n endOfContractGracePeriod: null,\n terminationFee: {\n type: 'PERCENTAGE',\n description: 'Fee',\n percentage: 100,\n price: null,\n estimatedCost: 324.56\n },\n renewal: null\n },\n currency: '...',\n customAttributes: [\n {attributeType: 'TEXT', name: '...', value: '...', valueKeys: ['...', '...']},\n {attributeType: 'TEXT', name: '...', value: '...', valueKeys: ['...', '...']}\n ],\n discount: {href: '...', id: '...'},\n discountId: 12345,\n endDate: 12345,\n endOfDiscountDate: 12345,\n frequency: '...',\n id: 12345,\n links: [{href: '...', rel: '...'}, {href: '...', rel: '...'}],\n nextBillingDate: 12345,\n nextOrder: {href: '...', id: '...'},\n oneTimeOrders: [\n {\n _embedded: {property1: {}, property2: {}},\n company: {},\n currency: '...',\n endDate: 12345,\n endOfDiscountDate: 12345,\n frequency: '...',\n id: 12345,\n links: [{}, {}],\n nextBillingDate: 12345,\n paymentPlan: {},\n referenceCode: '...',\n salesSupportUser: {},\n startDate: 12345,\n status: '...',\n totalPrice: 12345,\n type: '...',\n user: {}\n },\n {\n _embedded: {property1: {}, property2: {}},\n company: {},\n currency: '...',\n endDate: 12345,\n endOfDiscountDate: 12345,\n frequency: '...',\n id: 12345,\n links: [{}, {}],\n nextBillingDate: 12345,\n paymentPlan: {},\n referenceCode: '...',\n salesSupportUser: {},\n startDate: 12345,\n status: '...',\n totalPrice: 12345,\n type: '...',\n user: {}\n }\n ],\n orderLines: [{}, {}],\n parameters: [{name: '...', value: '...'}, {name: '...', value: '...'}],\n paymentPlan: {\n allowCustomUsage: true,\n contract: {},\n cost: [{}, {}],\n discount: {},\n frequency: '...',\n href: '...',\n id: 12345,\n isPrimaryPrice: true,\n keepBillDateOnUsageChange: true,\n primaryPrice: true,\n separatePrepaid: true,\n tld: '...',\n uuid: '...'\n },\n paymentPlanId: 12345,\n previousOrder: {href: '...', id: '...'},\n referenceCode: '...',\n salesSupportUser: {href: '...', id: '...'},\n startDate: 12345,\n status: '...',\n totalPrice: 12345,\n type: '...',\n user: {href: '...', id: '...'}\n },\n product: {href: '...', id: '...'},\n redirectUrl: '...',\n status: '...',\n upcomingOrder: {\n _embedded: {property1: {}, property2: {}},\n activated: true,\n company: {href: '...', id: '...'},\n contract: {},\n currency: '...',\n customAttributes: [\n {attributeType: 'TEXT', name: '...', value: '...', valueKeys: ['...', '...']},\n {attributeType: 'TEXT', name: '...', value: '...', valueKeys: ['...', '...']}\n ],\n discount: {href: '...', id: '...'},\n discountId: 12345,\n endDate: 12345,\n endOfDiscountDate: 12345,\n frequency: '...',\n id: 12345,\n links: [{href: '...', rel: '...'}, {href: '...', rel: '...'}],\n nextBillingDate: 12345,\n nextOrder: {href: '...', id: '...'},\n oneTimeOrders: [\n {\n _embedded: {property1: {}, property2: {}},\n company: {},\n currency: '...',\n endDate: 12345,\n endOfDiscountDate: 12345,\n frequency: '...',\n id: 12345,\n links: [{}, {}],\n nextBillingDate: 12345,\n paymentPlan: {},\n referenceCode: '...',\n salesSupportUser: {},\n startDate: 12345,\n status: '...',\n totalPrice: 12345,\n type: '...',\n user: {}\n },\n {\n _embedded: {property1: {}, property2: {}},\n company: {},\n currency: '...',\n endDate: 12345,\n endOfDiscountDate: 12345,\n frequency: '...',\n id: 12345,\n links: [{}, {}],\n nextBillingDate: 12345,\n paymentPlan: {},\n referenceCode: '...',\n salesSupportUser: {},\n startDate: 12345,\n status: '...',\n totalPrice: 12345,\n type: '...',\n user: {}\n }\n ],\n orderLines: [{}, {}],\n parameters: [{name: '...', value: '...'}, {name: '...', value: '...'}],\n paymentPlan: {\n allowCustomUsage: true,\n contract: {},\n cost: [{}, {}],\n discount: {},\n frequency: '...',\n href: '...',\n id: 12345,\n isPrimaryPrice: true,\n keepBillDateOnUsageChange: true,\n primaryPrice: true,\n separatePrepaid: true,\n tld: '...',\n uuid: '...'\n },\n paymentPlanId: 12345,\n previousOrder: {href: '...', id: '...'},\n referenceCode: '...',\n salesSupportUser: {href: '...', id: '...'},\n startDate: 12345,\n status: '...',\n totalPrice: 12345,\n type: '...',\n user: {href: '...', id: '...'}\n },\n user: {href: '...', id: '...'}\n },\n json: true\n};\n\nrequest(options, function (error, response, body) {\n if (error) throw new Error(error);\n\n console.log(body);\n});\n" - lang: Java + Okhttp source: "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"assignedUsers\\\":12345,\\\"bundleApplicationId\\\":12345,\\\"company\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"},\\\"creationDate\\\":12345,\\\"edition\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"},\\\"endDate\\\":12345,\\\"externalAccountId\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\",\\\"internalId\\\":\\\"...\\\",\\\"maxUsers\\\":12345,\\\"order\\\":{\\\"_embedded\\\":{\\\"property1\\\":{},\\\"property2\\\":{}},\\\"activated\\\":true,\\\"company\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"},\\\"contract\\\":{\\\"minimumServiceLength\\\":24,\\\"endOfContractDate\\\":123451232,\\\"gracePeriodEndDate\\\":null,\\\"cancellationPeriodLimit\\\":null,\\\"endOfContractGracePeriod\\\":null,\\\"terminationFee\\\":{\\\"type\\\":\\\"PERCENTAGE\\\",\\\"description\\\":\\\"Fee\\\",\\\"percentage\\\":100,\\\"price\\\":null,\\\"estimatedCost\\\":324.56},\\\"renewal\\\":null},\\\"currency\\\":\\\"...\\\",\\\"customAttributes\\\":[{\\\"attributeType\\\":\\\"TEXT\\\",\\\"name\\\":\\\"...\\\",\\\"value\\\":\\\"...\\\",\\\"valueKeys\\\":[\\\"...\\\",\\\"...\\\"]},{\\\"attributeType\\\":\\\"TEXT\\\",\\\"name\\\":\\\"...\\\",\\\"value\\\":\\\"...\\\",\\\"valueKeys\\\":[\\\"...\\\",\\\"...\\\"]}],\\\"discount\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"},\\\"discountId\\\":12345,\\\"endDate\\\":12345,\\\"endOfDiscountDate\\\":12345,\\\"frequency\\\":\\\"...\\\",\\\"id\\\":12345,\\\"links\\\":[{\\\"href\\\":\\\"...\\\",\\\"rel\\\":\\\"...\\\"},{\\\"href\\\":\\\"...\\\",\\\"rel\\\":\\\"...\\\"}],\\\"nextBillingDate\\\":12345,\\\"nextOrder\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"},\\\"oneTimeOrders\\\":[{\\\"_embedded\\\":{\\\"property1\\\":{},\\\"property2\\\":{}},\\\"company\\\":{},\\\"currency\\\":\\\"...\\\",\\\"endDate\\\":12345,\\\"endOfDiscountDate\\\":12345,\\\"frequency\\\":\\\"...\\\",\\\"id\\\":12345,\\\"links\\\":[{},{}],\\\"nextBillingDate\\\":12345,\\\"paymentPlan\\\":{},\\\"referenceCode\\\":\\\"...\\\",\\\"salesSupportUser\\\":{},\\\"startDate\\\":12345,\\\"status\\\":\\\"...\\\",\\\"totalPrice\\\":12345,\\\"type\\\":\\\"...\\\",\\\"user\\\":{}},{\\\"_embedded\\\":{\\\"property1\\\":{},\\\"property2\\\":{}},\\\"company\\\":{},\\\"currency\\\":\\\"...\\\",\\\"endDate\\\":12345,\\\"endOfDiscountDate\\\":12345,\\\"frequency\\\":\\\"...\\\",\\\"id\\\":12345,\\\"links\\\":[{},{}],\\\"nextBillingDate\\\":12345,\\\"paymentPlan\\\":{},\\\"referenceCode\\\":\\\"...\\\",\\\"salesSupportUser\\\":{},\\\"startDate\\\":12345,\\\"status\\\":\\\"...\\\",\\\"totalPrice\\\":12345,\\\"type\\\":\\\"...\\\",\\\"user\\\":{}}],\\\"orderLines\\\":[{},{}],\\\"parameters\\\":[{\\\"name\\\":\\\"...\\\",\\\"value\\\":\\\"...\\\"},{\\\"name\\\":\\\"...\\\",\\\"value\\\":\\\"...\\\"}],\\\"paymentPlan\\\":{\\\"allowCustomUsage\\\":true,\\\"contract\\\":{},\\\"cost\\\":[{},{}],\\\"discount\\\":{},\\\"frequency\\\":\\\"...\\\",\\\"href\\\":\\\"...\\\",\\\"id\\\":12345,\\\"isPrimaryPrice\\\":true,\\\"keepBillDateOnUsageChange\\\":true,\\\"primaryPrice\\\":true,\\\"separatePrepaid\\\":true,\\\"tld\\\":\\\"...\\\",\\\"uuid\\\":\\\"...\\\"},\\\"paymentPlanId\\\":12345,\\\"previousOrder\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"},\\\"referenceCode\\\":\\\"...\\\",\\\"salesSupportUser\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"},\\\"startDate\\\":12345,\\\"status\\\":\\\"...\\\",\\\"totalPrice\\\":12345,\\\"type\\\":\\\"...\\\",\\\"user\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"}},\\\"product\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"},\\\"redirectUrl\\\":\\\"...\\\",\\\"status\\\":\\\"...\\\",\\\"upcomingOrder\\\":{\\\"_embedded\\\":{\\\"property1\\\":{},\\\"property2\\\":{}},\\\"activated\\\":true,\\\"company\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"},\\\"contract\\\":{},\\\"currency\\\":\\\"...\\\",\\\"customAttributes\\\":[{\\\"attributeType\\\":\\\"TEXT\\\",\\\"name\\\":\\\"...\\\",\\\"value\\\":\\\"...\\\",\\\"valueKeys\\\":[\\\"...\\\",\\\"...\\\"]},{\\\"attributeType\\\":\\\"TEXT\\\",\\\"name\\\":\\\"...\\\",\\\"value\\\":\\\"...\\\",\\\"valueKeys\\\":[\\\"...\\\",\\\"...\\\"]}],\\\"discount\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"},\\\"discountId\\\":12345,\\\"endDate\\\":12345,\\\"endOfDiscountDate\\\":12345,\\\"frequency\\\":\\\"...\\\",\\\"id\\\":12345,\\\"links\\\":[{\\\"href\\\":\\\"...\\\",\\\"rel\\\":\\\"...\\\"},{\\\"href\\\":\\\"...\\\",\\\"rel\\\":\\\"...\\\"}],\\\"nextBillingDate\\\":12345,\\\"nextOrder\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"},\\\"oneTimeOrders\\\":[{\\\"_embedded\\\":{\\\"property1\\\":{},\\\"property2\\\":{}},\\\"company\\\":{},\\\"currency\\\":\\\"...\\\",\\\"endDate\\\":12345,\\\"endOfDiscountDate\\\":12345,\\\"frequency\\\":\\\"...\\\",\\\"id\\\":12345,\\\"links\\\":[{},{}],\\\"nextBillingDate\\\":12345,\\\"paymentPlan\\\":{},\\\"referenceCode\\\":\\\"...\\\",\\\"salesSupportUser\\\":{},\\\"startDate\\\":12345,\\\"status\\\":\\\"...\\\",\\\"totalPrice\\\":12345,\\\"type\\\":\\\"...\\\",\\\"user\\\":{}},{\\\"_embedded\\\":{\\\"property1\\\":{},\\\"property2\\\":{}},\\\"company\\\":{},\\\"currency\\\":\\\"...\\\",\\\"endDate\\\":12345,\\\"endOfDiscountDate\\\":12345,\\\"frequency\\\":\\\"...\\\",\\\"id\\\":12345,\\\"links\\\":[{},{}],\\\"nextBillingDate\\\":12345,\\\"paymentPlan\\\":{},\\\"referenceCode\\\":\\\"...\\\",\\\"salesSupportUser\\\":{},\\\"startDate\\\":12345,\\\"status\\\":\\\"...\\\",\\\"totalPrice\\\":12345,\\\"type\\\":\\\"...\\\",\\\"user\\\":{}}],\\\"orderLines\\\":[{},{}],\\\"parameters\\\":[{\\\"name\\\":\\\"...\\\",\\\"value\\\":\\\"...\\\"},{\\\"name\\\":\\\"...\\\",\\\"value\\\":\\\"...\\\"}],\\\"paymentPlan\\\":{\\\"allowCustomUsage\\\":true,\\\"contract\\\":{},\\\"cost\\\":[{},{}],\\\"discount\\\":{},\\\"frequency\\\":\\\"...\\\",\\\"href\\\":\\\"...\\\",\\\"id\\\":12345,\\\"isPrimaryPrice\\\":true,\\\"keepBillDateOnUsageChange\\\":true,\\\"primaryPrice\\\":true,\\\"separatePrepaid\\\":true,\\\"tld\\\":\\\"...\\\",\\\"uuid\\\":\\\"...\\\"},\\\"paymentPlanId\\\":12345,\\\"previousOrder\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"},\\\"referenceCode\\\":\\\"...\\\",\\\"salesSupportUser\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"},\\\"startDate\\\":12345,\\\"status\\\":\\\"...\\\",\\\"totalPrice\\\":12345,\\\"type\\\":\\\"...\\\",\\\"user\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"}},\\\"user\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"}}\");\nRequest request = new Request.Builder()\n .url(\"https://marketplace.appdirect.com/api/billing/v1/companies/%7BcompanyId%7D/users/%7BuserId%7D/subscriptions/preview\")\n .post(body)\n .build();\n\nResponse response = client.newCall(request).execute();" /billing/v1/subscriptions/{subscriptionId}/orders: get: description: List all the purchase orders for the given subscription tags: - Subscriptions summary: List all purchase orders for a subscription operationId: resource_Other_readSubscriptionPurchaseOrders_GET parameters: - description: Subscription ID. name: subscriptionId in: path required: true schema: type: string - description: 'Filters results to only include subscriptions where billing starts on or after the specified date (format: Mon March 01 00:00:00 EDT 2015)' name: startDateFrom in: query schema: type: string - description: 'Filters results to only include subscriptions where billing starts on or before the specified date (format: Mon March 01 00:00:00 EDT 2015)' name: startDateTo in: query schema: type: string - description: Filters subscriptions by order status name: status in: query schema: type: string enum: - INITIALIZED - PENDING_USER_APPROVAL - PENDING_REMOTE_CREATION - PENDING_MANUAL_RECOVERY - PENDING_ASYNCHRONOUS_CREATION - FREE_TRIAL - ACTIVE - FINISHED - ONE_TIME - CANCELLED - SUSPENDED - FREE_TRIAL_EXPIRED - FREE_TRIAL_CANCELLED - DELETED - FAILED - UPCOMING - PENDING_MIGRATION_ACTIVATION - PENDING_DELAYED_PROVISIONING - description: Filters subscriptions by currency name: currency in: query schema: type: string enum: - USD - CAD - EUR - JPY - GBP - KRW - CHF - SEK - SGD - MYR - AUD - MXN - INR - BRL - DKK - NZD - NOK - ZAR - PHP - CNY - SAR - GTQ - IDR - ARS - COP - PEN - description: 'Filters subscriptions by order type.
NEW: The first order of a subscription. The order contains flat fees (one time or recurring) for this subscription. It is active until the subscription is updated or canceled.
MIGRATION: The order created after a subscription change. The order includes flat fees for both one-time and recurring editions.
ADOPTION: The order created by an administrator who has taken ownership of an application from another user within the same company.
FREE_TRIAL_ACTIVATION: Created when a free trial is manually upgraded to a paid subscription. Any subscription that is updated from free trial to paid automatically keeps its NEW status purchase order.
TERMINATION_FEE: A subscription is canceled that had a termination fee. This purchase order represents the fees incurred as a result of the cancellation.
END_OF_CONTRACT_MIGRATION: Created when a subscription update takes place as a result of a contract extension. If the contract autorenewal is set to either continue without a contract or renew the contract with the same pricing plan, then no migration occurs and the original purchase order is updated to include the new end date for the contract.
REFUND: Created when a refund is performed. The refund purchase order is created for only on-platform refunds. Off-platform refunds do not generate this type of purchase order.
CREDIT: Created during subscription update events. Any subscription update calculates a paid period and a credit period. The credit is then provided to the user to prorate the subscription.
ONE_TIME_FEE: Created if an edition includes one-time setup fees.
ADDITIONAL_FEE: Used for off-order charges. A developer change creates an off-order charge and charges their customer a custom amount outside of the normal subscription cycle.
END_OF_DISCOUNT_MIGRATION: Created after a discount of limited duration expires. This purchase order is created to represent the updated costs without the discount.
METERED_USAGE: A purchase order created to accumulate usage fees during a billing period. The order is only valid for the billing period but it is updated with usage lines over the course of the billing period. A metered purchase order is invoiced in arrears at the end of the billing cycle.' name: type in: query schema: type: string enum: - NEW - MIGRATION - ADOPTION - FREE_TRIAL_ACTIVATION - TERMINATION_FEE - END_OF_CONTRACT_MIGRATION - REFUND - CREDIT - ONE_TIME_FEE - ADDITIONAL_FEE - END_OF_DISCOUNT_MIGRATION - METERED_USAGE - description: Filters subscriptions by pricing frequency name: frequency in: query schema: type: string enum: - ONE_TIME - MONTHLY - QUARTERLY - SIX_MONTHS - YEARLY - TWO_YEARS - THREE_YEARS - DAILY - description: Filters subscriptions by order reference code name: orderReferenceCode in: query schema: type: string - description: Filters subscriptions by internal application ID name: applicationIds in: query schema: type: number - description: Filters results to only include subscriptions that were created on or after the specified date name: fromCreationDate in: query schema: type: number - description: Filters results to only include subscriptions that were created on or before the specified date name: toCreationDate in: query schema: type: number - description: Number of results to fetch. Used for paging. name: count in: query schema: type: integer default: 250 - description: Sort field. name: sortField in: query schema: type: string enum: - DATE - ORDER_ID - TOTAL default: DATE - description: Sort order. name: sortOrder in: query schema: type: string enum: - ASC - DESC default: ASC - description: First result index. Used for paging. name: start in: query schema: type: integer default: 0 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/OrderDetailedListingWS' examples: response: value: orders: - startDate: 1480999443538 endDate: null nextBillingDate: 1483677843538 endOfDiscountDate: null status: ACTIVE frequency: MONTHLY currency: USD type: NEW totalPrice: 0 user: id: ef508ef9-5814-4788-aba4-488d98947c4c href: http://appdirect/api/account/v1/users/ef508ef9-5814-4788-aba4-488d98947c4c salesSupportUser: null company: id: a470269b-f5d1-4e33-b739-9835f50c0683 href: http://appdirect/api/account/v1/companies/a470269b-f5d1-4e33-b739-9835f50c0683 referenceCode: null paymentPlan: href: http://appdirect/api/marketplace/v1/products/11/editions/14/paymentPlans/24 id: 24 uuid: 865c805d-5efd-459d-b605-3b6587376727 frequency: MONTHLY contract: minimumServiceLength: 3 cancellationPeriodLimit: null endOfContractGracePeriod: null blockSwitchToShorterContract: false blockContractDowngrades: false blockContractUpgrades: false alignWithParentCycleStartDate: false gracePeriod: null terminationFee: null autoExtensionPricingId: 24 allowCustomUsage: false keepBillDateOnUsageChange: false separatePrepaid: false isPrimaryPrice: false costs: - id: 24 unit: USER unitDependency: null minUnits: 0 maxUnits: null meteredUsage: false increment: 1 pricePerIncrement: false blockContractDecrease: false blockContractIncrease: false blockOriginalContractDecrease: false amount: USD: 10 pricingStrategy: UNIT discount: null primaryPrice: false contract: null previousOrder: null nextOrder: null discount: null paymentPlanId: 24 discountId: null activated: false oneTimeOrders: [] orderLines: [] parameters: [] links: - rel: subscription href: http://appdirect/api/billing/v1/subscriptions/5096ed99-675b-449a-926e-0ee2c0aa4128 id: 15 total: 1 application/xml: schema: $ref: '#/components/schemas/OrderDetailedListingWS' x-codeSamples: - lang: Shell + Curl source: "curl --request GET \\\n --url 'https://marketplace.appdirect.com/api/billing/v1/subscriptions/%7BsubscriptionId%7D/orders?startDateFrom=SOME_STRING_VALUE&startDateTo=SOME_STRING_VALUE&status=SOME_STRING_VALUE¤cy=SOME_STRING_VALUE&type=SOME_STRING_VALUE&frequency=SOME_STRING_VALUE&orderReferenceCode=SOME_STRING_VALUE&applicationIds=SOME_NUMBER_VALUE&fromCreationDate=SOME_NUMBER_VALUE&toCreationDate=SOME_NUMBER_VALUE&count=SOME_INTEGER_VALUE&sortField=SOME_STRING_VALUE&sortOrder=SOME_STRING_VALUE&start=SOME_INTEGER_VALUE'" - lang: Node + Request source: "const request = require('request');\n\nconst options = {\n method: 'GET',\n url: 'https://marketplace.appdirect.com/api/billing/v1/subscriptions/%7BsubscriptionId%7D/orders',\n qs: {\n startDateFrom: 'SOME_STRING_VALUE',\n startDateTo: 'SOME_STRING_VALUE',\n status: 'SOME_STRING_VALUE',\n currency: 'SOME_STRING_VALUE',\n type: 'SOME_STRING_VALUE',\n frequency: 'SOME_STRING_VALUE',\n orderReferenceCode: 'SOME_STRING_VALUE',\n applicationIds: 'SOME_NUMBER_VALUE',\n fromCreationDate: 'SOME_NUMBER_VALUE',\n toCreationDate: 'SOME_NUMBER_VALUE',\n count: 'SOME_INTEGER_VALUE',\n sortField: 'SOME_STRING_VALUE',\n sortOrder: 'SOME_STRING_VALUE',\n start: 'SOME_INTEGER_VALUE'\n }\n};\n\nrequest(options, function (error, response, body) {\n if (error) throw new Error(error);\n\n console.log(body);\n});\n" - lang: Java + Okhttp source: "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://marketplace.appdirect.com/api/billing/v1/subscriptions/%7BsubscriptionId%7D/orders?startDateFrom=SOME_STRING_VALUE&startDateTo=SOME_STRING_VALUE&status=SOME_STRING_VALUE¤cy=SOME_STRING_VALUE&type=SOME_STRING_VALUE&frequency=SOME_STRING_VALUE&orderReferenceCode=SOME_STRING_VALUE&applicationIds=SOME_NUMBER_VALUE&fromCreationDate=SOME_NUMBER_VALUE&toCreationDate=SOME_NUMBER_VALUE&count=SOME_INTEGER_VALUE&sortField=SOME_STRING_VALUE&sortOrder=SOME_STRING_VALUE&start=SOME_INTEGER_VALUE\")\n .get()\n .build();\n\nResponse response = client.newCall(request).execute();" /billing/v1/subscriptions/{subscriptionId}/addons/{addonInstanceUuid}: put: description: Update the given add-on instance on the given subscription using the provided data tags: - Subscriptions summary: Update an add-on instance operationId: resource_Subscription_changeAddonInstance_PUT parameters: - name: addonInstanceUuid in: path required: true schema: type: string - description: Subscription ID name: subscriptionId in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AddonInstanceWS' application/xml: schema: $ref: '#/components/schemas/AddonInstanceWS' description: Add-on instance object responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AddonInstanceWS' examples: response: value: uuid: 14b0888d-400b-468a-a14e-a7d65cc900df offeringUuid: edfd3e97-642b-4a39-b7e2-41ae36b35b73 units: 10 application/xml: schema: $ref: '#/components/schemas/AddonInstanceWS' '404': description: Not Found x-codeSamples: - lang: Shell + Curl source: "curl --request PUT \\\n --url https://marketplace.appdirect.com/api/billing/v1/subscriptions/%7BsubscriptionId%7D/addons/%7BaddonInstanceUuid%7D \\\n --data '{\"creationDate\":12345,\"offeringUuid\":\"...\",\"order\":{\"_embedded\":{\"property1\":{},\"property2\":{}},\"activated\":true,\"company\":{\"href\":\"...\",\"id\":\"...\"},\"contract\":{},\"currency\":\"...\",\"customAttribute\":[{\"attributeType\":\"MULTISELECT\",\"name\":\"...\",\"value\":\"...\",\"valueKeys\":[\"...\",\"...\"]},{\"attributeType\":\"MULTISELECT\",\"name\":\"...\",\"value\":\"...\",\"valueKeys\":[\"...\",\"...\"]}],\"discount\":{\"href\":\"...\",\"id\":\"...\"},\"discountId\":12345,\"endDate\":12345,\"endOfDiscountDate\":12345,\"frequency\":\"...\",\"id\":12345,\"links\":[{\"href\":\"...\",\"rel\":\"...\"},{\"href\":\"...\",\"rel\":\"...\"}],\"nextBillingDate\":12345,\"nextOrder\":{\"href\":\"...\",\"id\":\"...\"},\"oneTimeOrder\":[{\"_embedded\":{\"property1\":{},\"property2\":{}},\"company\":{},\"currency\":\"...\",\"endDate\":12345,\"endOfDiscountDate\":12345,\"frequency\":\"...\",\"id\":12345,\"links\":[{},{}],\"nextBillingDate\":12345,\"paymentPlan\":{},\"referenceCode\":\"...\",\"salesSupportUser\":{},\"startDate\":12345,\"status\":\"...\",\"totalPrice\":12345,\"type\":\"...\",\"user\":{}},{\"_embedded\":{\"property1\":{},\"property2\":{}},\"company\":{},\"currency\":\"...\",\"endDate\":12345,\"endOfDiscountDate\":12345,\"frequency\":\"...\",\"id\":12345,\"links\":[{},{}],\"nextBillingDate\":12345,\"paymentPlan\":{},\"referenceCode\":\"...\",\"salesSupportUser\":{},\"startDate\":12345,\"status\":\"...\",\"totalPrice\":12345,\"type\":\"...\",\"user\":{}}],\"orderLine\":[{},{}],\"parameter\":[{\"name\":\"...\",\"value\":\"...\"},{\"name\":\"...\",\"value\":\"...\"}],\"paymentPlan\":{\"allowCustomUsage\":true,\"contract\":{},\"cost\":[{},{}],\"discount\":{},\"frequency\":\"...\",\"href\":\"...\",\"id\":12345,\"isPrimaryPrice\":true,\"keepBillDateOnUsageChange\":true,\"primaryPrice\":true,\"separatePrepaid\":true,\"tld\":\"...\",\"uuid\":\"...\"},\"paymentPlanId\":12345,\"previousOrder\":{\"href\":\"...\",\"id\":\"...\"},\"referenceCode\":\"...\",\"salesSupportUser\":{\"href\":\"...\",\"id\":\"...\"},\"startDate\":12345,\"status\":\"...\",\"totalPrice\":12345,\"type\":\"...\",\"user\":{\"href\":\"...\",\"id\":\"...\"}},\"status\":\"...\",\"units\":12345,\"uuid\":\"...\"}'" - lang: Node + Request source: "const request = require('request');\n\nconst options = {\n method: 'PUT',\n url: 'https://marketplace.appdirect.com/api/billing/v1/subscriptions/%7BsubscriptionId%7D/addons/%7BaddonInstanceUuid%7D',\n body: {\n creationDate: 12345,\n offeringUuid: '...',\n order: {\n _embedded: {property1: {}, property2: {}},\n activated: true,\n company: {href: '...', id: '...'},\n contract: {},\n currency: '...',\n customAttribute: [\n {\n attributeType: 'MULTISELECT',\n name: '...',\n value: '...',\n valueKeys: ['...', '...']\n },\n {\n attributeType: 'MULTISELECT',\n name: '...',\n value: '...',\n valueKeys: ['...', '...']\n }\n ],\n discount: {href: '...', id: '...'},\n discountId: 12345,\n endDate: 12345,\n endOfDiscountDate: 12345,\n frequency: '...',\n id: 12345,\n links: [{href: '...', rel: '...'}, {href: '...', rel: '...'}],\n nextBillingDate: 12345,\n nextOrder: {href: '...', id: '...'},\n oneTimeOrder: [\n {\n _embedded: {property1: {}, property2: {}},\n company: {},\n currency: '...',\n endDate: 12345,\n endOfDiscountDate: 12345,\n frequency: '...',\n id: 12345,\n links: [{}, {}],\n nextBillingDate: 12345,\n paymentPlan: {},\n referenceCode: '...',\n salesSupportUser: {},\n startDate: 12345,\n status: '...',\n totalPrice: 12345,\n type: '...',\n user: {}\n },\n {\n _embedded: {property1: {}, property2: {}},\n company: {},\n currency: '...',\n endDate: 12345,\n endOfDiscountDate: 12345,\n frequency: '...',\n id: 12345,\n links: [{}, {}],\n nextBillingDate: 12345,\n paymentPlan: {},\n referenceCode: '...',\n salesSupportUser: {},\n startDate: 12345,\n status: '...',\n totalPrice: 12345,\n type: '...',\n user: {}\n }\n ],\n orderLine: [{}, {}],\n parameter: [{name: '...', value: '...'}, {name: '...', value: '...'}],\n paymentPlan: {\n allowCustomUsage: true,\n contract: {},\n cost: [{}, {}],\n discount: {},\n frequency: '...',\n href: '...',\n id: 12345,\n isPrimaryPrice: true,\n keepBillDateOnUsageChange: true,\n primaryPrice: true,\n separatePrepaid: true,\n tld: '...',\n uuid: '...'\n },\n paymentPlanId: 12345,\n previousOrder: {href: '...', id: '...'},\n referenceCode: '...',\n salesSupportUser: {href: '...', id: '...'},\n startDate: 12345,\n status: '...',\n totalPrice: 12345,\n type: '...',\n user: {href: '...', id: '...'}\n },\n status: '...',\n units: 12345,\n uuid: '...'\n },\n json: true\n};\n\nrequest(options, function (error, response, body) {\n if (error) throw new Error(error);\n\n console.log(body);\n});\n" - lang: Java + Okhttp source: "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"creationDate\\\":12345,\\\"offeringUuid\\\":\\\"...\\\",\\\"order\\\":{\\\"_embedded\\\":{\\\"property1\\\":{},\\\"property2\\\":{}},\\\"activated\\\":true,\\\"company\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"},\\\"contract\\\":{},\\\"currency\\\":\\\"...\\\",\\\"customAttribute\\\":[{\\\"attributeType\\\":\\\"MULTISELECT\\\",\\\"name\\\":\\\"...\\\",\\\"value\\\":\\\"...\\\",\\\"valueKeys\\\":[\\\"...\\\",\\\"...\\\"]},{\\\"attributeType\\\":\\\"MULTISELECT\\\",\\\"name\\\":\\\"...\\\",\\\"value\\\":\\\"...\\\",\\\"valueKeys\\\":[\\\"...\\\",\\\"...\\\"]}],\\\"discount\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"},\\\"discountId\\\":12345,\\\"endDate\\\":12345,\\\"endOfDiscountDate\\\":12345,\\\"frequency\\\":\\\"...\\\",\\\"id\\\":12345,\\\"links\\\":[{\\\"href\\\":\\\"...\\\",\\\"rel\\\":\\\"...\\\"},{\\\"href\\\":\\\"...\\\",\\\"rel\\\":\\\"...\\\"}],\\\"nextBillingDate\\\":12345,\\\"nextOrder\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"},\\\"oneTimeOrder\\\":[{\\\"_embedded\\\":{\\\"property1\\\":{},\\\"property2\\\":{}},\\\"company\\\":{},\\\"currency\\\":\\\"...\\\",\\\"endDate\\\":12345,\\\"endOfDiscountDate\\\":12345,\\\"frequency\\\":\\\"...\\\",\\\"id\\\":12345,\\\"links\\\":[{},{}],\\\"nextBillingDate\\\":12345,\\\"paymentPlan\\\":{},\\\"referenceCode\\\":\\\"...\\\",\\\"salesSupportUser\\\":{},\\\"startDate\\\":12345,\\\"status\\\":\\\"...\\\",\\\"totalPrice\\\":12345,\\\"type\\\":\\\"...\\\",\\\"user\\\":{}},{\\\"_embedded\\\":{\\\"property1\\\":{},\\\"property2\\\":{}},\\\"company\\\":{},\\\"currency\\\":\\\"...\\\",\\\"endDate\\\":12345,\\\"endOfDiscountDate\\\":12345,\\\"frequency\\\":\\\"...\\\",\\\"id\\\":12345,\\\"links\\\":[{},{}],\\\"nextBillingDate\\\":12345,\\\"paymentPlan\\\":{},\\\"referenceCode\\\":\\\"...\\\",\\\"salesSupportUser\\\":{},\\\"startDate\\\":12345,\\\"status\\\":\\\"...\\\",\\\"totalPrice\\\":12345,\\\"type\\\":\\\"...\\\",\\\"user\\\":{}}],\\\"orderLine\\\":[{},{}],\\\"parameter\\\":[{\\\"name\\\":\\\"...\\\",\\\"value\\\":\\\"...\\\"},{\\\"name\\\":\\\"...\\\",\\\"value\\\":\\\"...\\\"}],\\\"paymentPlan\\\":{\\\"allowCustomUsage\\\":true,\\\"contract\\\":{},\\\"cost\\\":[{},{}],\\\"discount\\\":{},\\\"frequency\\\":\\\"...\\\",\\\"href\\\":\\\"...\\\",\\\"id\\\":12345,\\\"isPrimaryPrice\\\":true,\\\"keepBillDateOnUsageChange\\\":true,\\\"primaryPrice\\\":true,\\\"separatePrepaid\\\":true,\\\"tld\\\":\\\"...\\\",\\\"uuid\\\":\\\"...\\\"},\\\"paymentPlanId\\\":12345,\\\"previousOrder\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"},\\\"referenceCode\\\":\\\"...\\\",\\\"salesSupportUser\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"},\\\"startDate\\\":12345,\\\"status\\\":\\\"...\\\",\\\"totalPrice\\\":12345,\\\"type\\\":\\\"...\\\",\\\"user\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"}},\\\"status\\\":\\\"...\\\",\\\"units\\\":12345,\\\"uuid\\\":\\\"...\\\"}\");\nRequest request = new Request.Builder()\n .url(\"https://marketplace.appdirect.com/api/billing/v1/subscriptions/%7BsubscriptionId%7D/addons/%7BaddonInstanceUuid%7D\")\n .put(body)\n .build();\n\nResponse response = client.newCall(request).execute();" delete: description: Delete the given add-on instance on the given subscription tags: - Subscriptions summary: Delete an add-on instance operationId: resource_Subscription_cancelAddonInstance_DELETE parameters: - name: addonInstanceUuid in: path required: true schema: type: string - description: Subscription ID name: subscriptionId in: path required: true schema: type: string responses: '204': description: No Content '404': description: Not Found x-codeSamples: - lang: Shell + Curl source: "curl --request DELETE \\\n --url https://marketplace.appdirect.com/api/billing/v1/subscriptions/%7BsubscriptionId%7D/addons/%7BaddonInstanceUuid%7D" - lang: Node + Request source: "const request = require('request');\n\nconst options = {\n method: 'DELETE',\n url: 'https://marketplace.appdirect.com/api/billing/v1/subscriptions/%7BsubscriptionId%7D/addons/%7BaddonInstanceUuid%7D'\n};\n\nrequest(options, function (error, response, body) {\n if (error) throw new Error(error);\n\n console.log(body);\n});\n" - lang: Java + Okhttp source: "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://marketplace.appdirect.com/api/billing/v1/subscriptions/%7BsubscriptionId%7D/addons/%7BaddonInstanceUuid%7D\")\n .delete(null)\n .build();\n\nResponse response = client.newCall(request).execute();" /billing/v1/subscriptions: get: description: The list may be filtered using the optional filter parameters tags: - Subscriptions summary: List all subscriptions operationId: resource_Subscription_readSubscriptions_GET parameters: - description: Filters results to only include subscriptions that were created on or after the specified date in yyyy/MM/DD HH:mm:ss format name: fromDate in: query schema: type: string - description: Filters results to only include subscriptions that were created on or before the specified date in yyyy/MM/DD HH:mm:ss format name: toDate in: query schema: type: string - description: Filters subscriptions by internal discount ID name: discountId in: query schema: type: number - description: Filters subscriptions by order status name: status in: query schema: type: string items: enum: - INITIALIZED - FAILED - FREE_TRIAL - FREE_TRIAL_EXPIRED - ACTIVE - SUSPENDED - CANCELLED type: string - description: Filters subscriptions by internal edition ID name: editionId in: query schema: type: number - description: Filters subscriptions by internal payment plan ID name: paymentPlanId in: query schema: type: number - description: Filters results to only include subscriptions that were modified on or after the specified date in UNIX Epoch milliseconds name: lastModified in: query schema: type: number - description: Filters subscriptions by internal Application ID name: applicationIds in: query schema: type: number - description: Filters subscriptions by internal bundle ID name: bundleApplicationId in: query schema: type: number - description: Expands filtered subscription results to include details about the specified query parameters, one or more of "order", "product", or "edition". name: expand in: query schema: type: string - description: Filters subscriptions by order reference code name: orderReferenceCode in: query schema: type: string - description: Number of results to fetch. Used for paging. name: count in: query schema: type: integer default: 250 - description: Sort field name: sortField in: query schema: type: string enum: - APPLICATION - COMPANY - DATE - OWNER - STATUS - SUBSCRIPTION_ID default: DATE - description: Sort order name: sortOrder in: query schema: type: string enum: - ASC - DESC default: ASC - description: First result index. Used for paging. name: start in: query schema: type: integer default: 0 responses: '200': description: OK content: application/json: schema: description: OK type: array items: $ref: '#/components/schemas/SubscriptionWS' examples: response: value: - creationDate: 1480999444377 endDate: null externalAccountId: 16-account-identifier label: Example Label status: ACTIVE suspensionReason: null maxUsers: 0 assignmentCount: 1 parentSubscriptionId: null order: id: 16 href: http://appdirect/api/billing/v1/orders/16 user: id: 5ab780a4-1767-4799-9b83-5b898ac76763 href: http://appdirect/api/account/v1/users/5ab780a4-1767-4799-9b83-5b898ac76763 company: id: ff732167-9b1b-4dba-bc2e-dece04f8fb41 href: http://appdirect/api/account/v1/companies/ff732167-9b1b-4dba-bc2e-dece04f8fb41 product: id: '12' href: http://appdirect/api/marketplace/v1/products/12 edition: id: '15' href: http://appdirect/api/marketplace/v1/products/12/editions/15 links: [] _embedded: order: startDate: 1480999444367 endDate: null nextBillingDate: 1483677844367 endOfDiscountDate: null status: ACTIVE frequency: MONTHLY currency: USD type: NEW totalPrice: 0 user: id: 5ab780a4-1767-4799-9b83-5b898ac76763 href: http://appdirect/api/account/v1/users/5ab780a4-1767-4799-9b83-5b898ac76763 salesSupportUser: null company: id: ff732167-9b1b-4dba-bc2e-dece04f8fb41 href: http://appdirect/api/account/v1/companies/ff732167-9b1b-4dba-bc2e-dece04f8fb41 referenceCode: null paymentPlan: href: http://appdirect/api/marketplace/v1/products/12/editions/15/paymentPlans/26 id: 26 uuid: 292e4509-3a7b-41e3-87be-e47dcb51adf2 frequency: MONTHLY contract: minimumServiceLength: 3 cancellationPeriodLimit: null endOfContractGracePeriod: null blockSwitchToShorterContract: false blockContractDowngrades: false blockContractUpgrades: false alignWithParentCycleStartDate: false gracePeriod: null terminationFee: null autoExtensionPricingId: 26 allowCustomUsage: false keepBillDateOnUsageChange: false separatePrepaid: false isPrimaryPrice: false costs: - id: 26 unit: USER unitDependency: null minUnits: 0 maxUnits: null meteredUsage: false increment: 1 pricePerIncrement: false blockContractDecrease: false blockContractIncrease: false blockOriginalContractDecrease: false amount: USD: 10 pricingStrategy: UNIT discount: null primaryPrice: false contract: null previousOrder: null nextOrder: null discount: null paymentPlanId: 26 discountId: null activated: false oneTimeOrders: [] orderLines: [] parameters: [] links: - rel: subscription href: http://appdirect/api/billing/v1/subscriptions/3bdda3a2-4af6-48fd-be7c-39cbf2ded56f id: 16 id: 3bdda3a2-4af6-48fd-be7c-39cbf2ded56f application/xml: schema: description: OK type: array items: $ref: '#/components/schemas/SubscriptionWS' '404': description: Not Found x-codeSamples: - lang: Shell + Curl source: "curl --request GET \\\n --url 'https://marketplace.appdirect.com/api/billing/v1/subscriptions?fromDate=SOME_STRING_VALUE&toDate=SOME_STRING_VALUE&discountId=SOME_NUMBER_VALUE&status=SOME_STRING_VALUE&editionId=SOME_NUMBER_VALUE&paymentPlanId=SOME_NUMBER_VALUE&lastModified=SOME_NUMBER_VALUE&applicationIds=SOME_NUMBER_VALUE&bundleApplicationId=SOME_NUMBER_VALUE&expand=SOME_STRING_VALUE&orderReferenceCode=SOME_STRING_VALUE&count=SOME_INTEGER_VALUE&sortField=SOME_STRING_VALUE&sortOrder=SOME_STRING_VALUE&start=SOME_INTEGER_VALUE'" - lang: Node + Request source: "const request = require('request');\n\nconst options = {\n method: 'GET',\n url: 'https://marketplace.appdirect.com/api/billing/v1/subscriptions',\n qs: {\n fromDate: 'SOME_STRING_VALUE',\n toDate: 'SOME_STRING_VALUE',\n discountId: 'SOME_NUMBER_VALUE',\n status: 'SOME_STRING_VALUE',\n editionId: 'SOME_NUMBER_VALUE',\n paymentPlanId: 'SOME_NUMBER_VALUE',\n lastModified: 'SOME_NUMBER_VALUE',\n applicationIds: 'SOME_NUMBER_VALUE',\n bundleApplicationId: 'SOME_NUMBER_VALUE',\n expand: 'SOME_STRING_VALUE',\n orderReferenceCode: 'SOME_STRING_VALUE',\n count: 'SOME_INTEGER_VALUE',\n sortField: 'SOME_STRING_VALUE',\n sortOrder: 'SOME_STRING_VALUE',\n start: 'SOME_INTEGER_VALUE'\n }\n};\n\nrequest(options, function (error, response, body) {\n if (error) throw new Error(error);\n\n console.log(body);\n});\n" - lang: Java + Okhttp source: "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://marketplace.appdirect.com/api/billing/v1/subscriptions?fromDate=SOME_STRING_VALUE&toDate=SOME_STRING_VALUE&discountId=SOME_NUMBER_VALUE&status=SOME_STRING_VALUE&editionId=SOME_NUMBER_VALUE&paymentPlanId=SOME_NUMBER_VALUE&lastModified=SOME_NUMBER_VALUE&applicationIds=SOME_NUMBER_VALUE&bundleApplicationId=SOME_NUMBER_VALUE&expand=SOME_STRING_VALUE&orderReferenceCode=SOME_STRING_VALUE&count=SOME_INTEGER_VALUE&sortField=SOME_STRING_VALUE&sortOrder=SOME_STRING_VALUE&start=SOME_INTEGER_VALUE\")\n .get()\n .build();\n\nResponse response = client.newCall(request).execute();" /billing/v1/subscriptions/{subscriptionId}/payments: get: description: List all the payments for the given subscription tags: - Subscriptions summary: List all payments for a subscription operationId: resource_Subscription_readSubscriptionPayments_GET parameters: - description: Subscription ID name: subscriptionId in: path required: true schema: type: string - description: Number of results to fetch. Used for paging. name: count in: query schema: type: integer default: 250 - description: From date name: fromDate in: query schema: type: number - description: Payment method name: method in: query schema: type: string enum: - ADP_INVOICE - ARIBAPAY - BT_BILL - CLICKANDBUY - CLOUDFOUNDRY - CREDIT_CARD - CUMULA_BILL - DTAG - EXTERNAL_INVOICE - KREDITKARTE - LASTSCHRIFT_MRNEXNET - MANO_TEO_BILL - MANUAL - MARKETPLACE_CREDITS - NETS_ARVATO_INVOICE - NEXTEL - PAYPAL - ROGERS_CC_DTMF - ROGERS_CC_POS - SNAP - TBILL - THISTLE - TOICLEARING - description: Payment result name: result in: query schema: type: string enum: - FAILED - GATEWAY_NOT_AVAILABLE - MANUAL - SUCCESSFUL - description: Sort field name: sortField in: query schema: type: string enum: - AMOUNT - DATE - PAYMENT_ID default: PAYMENT_ID - description: Sort order name: sortOrder in: query schema: type: string enum: - ASC - DESC default: ASC - description: First result index. Used for paging. name: start in: query schema: type: integer default: 0 - description: To date name: toDate in: query schema: type: number responses: '200': description: OK content: application/json: schema: description: OK type: array items: $ref: '#/components/schemas/PaymentWS' examples: response: value: - paymentNumber: 3 date: 1480999442914 amount: 10 currency: USD result: SUCCESSFUL method: CREDIT_CARD transactionId: 123456abcdef user: id: f5dbf30d-233d-4b85-9737-e4711b509fb7 href: http://appdirect/api/account/v1/users/f5dbf30d-233d-4b85-9737-e4711b509fb7 company: id: 95b5f752-5ba7-487e-b555-7ebfd8ec3079 href: http://appdirect/api/account/v1/companies/95b5f752-5ba7-487e-b555-7ebfd8ec3079 gatewayResponse: avs: true cvv: true code: null message: null links: - rel: self href: http://appdirect/api/billing/v1/payments/3 application/xml: schema: description: OK type: array items: $ref: '#/components/schemas/PaymentWS' '404': description: Not Found x-codeSamples: - lang: Shell + Curl source: "curl --request GET \\\n --url 'https://marketplace.appdirect.com/api/billing/v1/subscriptions/%7BsubscriptionId%7D/payments?count=SOME_INTEGER_VALUE&fromDate=SOME_NUMBER_VALUE&method=SOME_STRING_VALUE&result=SOME_STRING_VALUE&sortField=SOME_STRING_VALUE&sortOrder=SOME_STRING_VALUE&start=SOME_INTEGER_VALUE&toDate=SOME_NUMBER_VALUE'" - lang: Node + Request source: "const request = require('request');\n\nconst options = {\n method: 'GET',\n url: 'https://marketplace.appdirect.com/api/billing/v1/subscriptions/%7BsubscriptionId%7D/payments',\n qs: {\n count: 'SOME_INTEGER_VALUE',\n fromDate: 'SOME_NUMBER_VALUE',\n method: 'SOME_STRING_VALUE',\n result: 'SOME_STRING_VALUE',\n sortField: 'SOME_STRING_VALUE',\n sortOrder: 'SOME_STRING_VALUE',\n start: 'SOME_INTEGER_VALUE',\n toDate: 'SOME_NUMBER_VALUE'\n }\n};\n\nrequest(options, function (error, response, body) {\n if (error) throw new Error(error);\n\n console.log(body);\n});\n" - lang: Java + Okhttp source: "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://marketplace.appdirect.com/api/billing/v1/subscriptions/%7BsubscriptionId%7D/payments?count=SOME_INTEGER_VALUE&fromDate=SOME_NUMBER_VALUE&method=SOME_STRING_VALUE&result=SOME_STRING_VALUE&sortField=SOME_STRING_VALUE&sortOrder=SOME_STRING_VALUE&start=SOME_INTEGER_VALUE&toDate=SOME_NUMBER_VALUE\")\n .get()\n .build();\n\nResponse response = client.newCall(request).execute();" /billing/v1/subscriptions/{subscriptionId}: get: description: Retrieve the subscription for the given subscription ID tags: - Subscriptions summary: Retrieve a subscription operationId: resource_Subscription_readSubscription_GET parameters: - description: The unique identifier for the subscription name: subscriptionId in: path required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SubscriptionWS' examples: response: value: id: 08e230e5-2895-478f-aaeb-3879f5fe5c33 creationDate: 1480999441698 endDate: null externalAccountId: 12-account-identifier label: Example Label status: ACTIVE maxUsers: 0 assignedUsers: 1 order: startDate: 1480999441682 endDate: null nextBillingDate: 1483677841682 endOfDiscountDate: null status: ACTIVE frequency: MONTHLY currency: USD type: NEW totalPrice: 0 user: id: 69474681-db96-4486-8954-34d12c23e415 href: http://appdirect/api/account/v1/users/69474681-db96-4486-8954-34d12c23e415 salesSupportUser: null company: id: 1a32fa08-839f-4594-9003-aa4081c84fff href: http://appdirect/api/account/v1/companies/1a32fa08-839f-4594-9003-aa4081c84fff referenceCode: null paymentPlan: href: http://appdirect/api/marketplace/v1/products/8/editions/11/paymentPlans/18 id: 18 uuid: feed23e0-de8c-4e6f-b70a-13b0f610b0f7 frequency: MONTHLY contract: minimumServiceLength: 3 cancellationPeriodLimit: null endOfContractGracePeriod: null blockSwitchToShorterContract: false blockContractDowngrades: false blockContractUpgrades: false alignWithParentCycleStartDate: false gracePeriod: null terminationFee: null autoExtensionPricingId: 18 allowCustomUsage: false keepBillDateOnUsageChange: false separatePrepaid: false isPrimaryPrice: false costs: - id: 18 unit: USER unitDependency: null minUnits: 0 maxUnits: null meteredUsage: false increment: 1 pricePerIncrement: false blockContractDecrease: false blockContractIncrease: false blockOriginalContractDecrease: false amount: USD: 10 pricingStrategy: UNIT discount: null primaryPrice: false contract: null previousOrder: null nextOrder: null discount: null paymentPlanId: 18 discountId: null activated: false oneTimeOrders: [] orderLines: [] parameters: [] links: - rel: subscription href: http://appdirect/api/billing/v1/subscriptions/08e230e5-2895-478f-aaeb-3879f5fe5c33 id: 12 upcomingOrder: null user: id: 69474681-db96-4486-8954-34d12c23e415 href: http://appdirect/api/account/v1/users/69474681-db96-4486-8954-34d12c23e415 company: id: 1a32fa08-839f-4594-9003-aa4081c84fff href: http://appdirect/api/account/v1/companies/1a32fa08-839f-4594-9003-aa4081c84fff product: id: '8' href: http://appdirect/api/marketplace/v1/products/8 edition: id: '11' href: http://appdirect/api/marketplace/v1/products/8/editions/11 redirectUrl: null customAttributes: - name: test1 values: - value1 - name: test2 values: - value2 - value3 application/xml: schema: $ref: '#/components/schemas/SubscriptionWS' '404': description: Not Found x-codeSamples: - lang: Shell + Curl source: "curl --request GET \\\n --url https://marketplace.appdirect.com/api/billing/v1/subscriptions/%7BsubscriptionId%7D" - lang: Node + Request source: "const request = require('request');\n\nconst options = {\n method: 'GET',\n url: 'https://marketplace.appdirect.com/api/billing/v1/subscriptions/%7BsubscriptionId%7D'\n};\n\nrequest(options, function (error, response, body) {\n if (error) throw new Error(error);\n\n console.log(body);\n});\n" - lang: Java + Okhttp source: "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://marketplace.appdirect.com/api/billing/v1/subscriptions/%7BsubscriptionId%7D\")\n .get()\n .build();\n\nResponse response = client.newCall(request).execute();" delete: description: Requests cancellation of the given subscription tags: - Subscriptions summary: Request cancellation operationId: resource_Subscription_cancelSubscription_DELETE parameters: - description: Subscription ID name: subscriptionId in: path required: true schema: type: string - description: Sends email notification if true name: sendNotification in: query schema: type: boolean default: true responses: '202': description: Subscription cancellation was requested successfully '204': description: Subscription cancellation was requested and executed successfully '404': description: Not Found x-codeSamples: - lang: Shell + Curl source: "curl --request DELETE \\\n --url 'https://marketplace.appdirect.com/api/billing/v1/subscriptions/%7BsubscriptionId%7D?sendNotification=SOME_BOOLEAN_VALUE'" - lang: Node + Request source: "const request = require('request');\n\nconst options = {\n method: 'DELETE',\n url: 'https://marketplace.appdirect.com/api/billing/v1/subscriptions/%7BsubscriptionId%7D',\n qs: {sendNotification: 'SOME_BOOLEAN_VALUE'}\n};\n\nrequest(options, function (error, response, body) {\n if (error) throw new Error(error);\n\n console.log(body);\n});\n" - lang: Java + Okhttp source: "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://marketplace.appdirect.com/api/billing/v1/subscriptions/%7BsubscriptionId%7D?sendNotification=SOME_BOOLEAN_VALUE\")\n .delete(null)\n .build();\n\nResponse response = client.newCall(request).execute();" patch: description: Use this request to manage subscription lifecycles (suspend and activate subscriptions), update external IDs, and add or change subscription custom attribute values. tags: - Subscriptions summary: Update subscriptions operationId: resource_Other_updateSubscription_PATCH parameters: - description: Subscription ID name: subscriptionId in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SubscriptionUpdateWS' application/xml: schema: $ref: '#/components/schemas/SubscriptionUpdateWS' description: Subscription data object responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SubscriptionWS' examples: response: value: id: 1b577640-9b77-47bc-beb8-ed59accb4836 creationDate: 1481002406580 endDate: null externalAccountId: d2f4acf1-fb5a-4c4a-921f-75c4b6bfff08 status: ACTIVE maxUsers: 1 assignedUsers: 1 order: startDate: 1480921200000 endDate: null nextBillingDate: 1483599600000 endOfDiscountDate: null status: PENDING_REMOTE_CREATION frequency: MONTHLY currency: USD type: MIGRATION totalPrice: 100 user: null salesSupportUser: null company: null referenceCode: null paymentPlan: href: http://appdirect/api/marketplace/v1/products/2/editions/2/paymentPlans/2 id: 2 uuid: eaca1aa5-4c4f-44cb-8cf4-eb0aa9267273 frequency: MONTHLY contract: minimumServiceLength: null cancellationPeriodLimit: null endOfContractGracePeriod: null blockSwitchToShorterContract: false blockContractDowngrades: false blockContractUpgrades: false alignWithParentCycleStartDate: false gracePeriod: null terminationFee: null autoExtensionPricingId: null allowCustomUsage: false keepBillDateOnUsageChange: false separatePrepaid: false isPrimaryPrice: false costs: - id: 2 unit: USER unitDependency: null minUnits: 0 maxUnits: null meteredUsage: false increment: 1 pricePerIncrement: false blockContractDecrease: false blockContractIncrease: false blockOriginalContractDecrease: false amount: USD: 10 pricingStrategy: UNIT discount: null primaryPrice: false contract: null previousOrder: null nextOrder: null discount: null paymentPlanId: 2 discountId: null activated: false oneTimeOrders: - startDate: 1480921200000 endDate: 1483599600000 nextBillingDate: 1483599600000 endOfDiscountDate: null status: INITIALIZED frequency: MONTHLY currency: USD type: CREDIT totalPrice: -10 user: null salesSupportUser: null company: null referenceCode: null paymentPlan: id: '2' href: http://appdirect/api/marketplace/v1/products/2/editions/2/paymentPlans/2 links: [] id: null orderLines: - type: ITEM unit: USER quantity: 10 price: 10 listingPrice: 10 totalPrice: 100 description: Test App 1 - null - Per User Fee parameters: [] links: - rel: subscription href: http://appdirect/api/billing/v1/subscriptions/1b577640-9b77-47bc-beb8-ed59accb4836 id: null upcomingOrder: null user: id: ce9ece33-3ea4-4e80-bbcf-4af251fcb37e href: https://appdirect/api/account/v1/users/ce9ece33-3ea4-4e80-bbcf-4af251fcb37e company: id: c37aa8fa-1585-4737-b04a-94e177198897 href: https://appdirect/api/account/v1/companies/c37aa8fa-1585-4737-b04a-94e177198897 product: id: '640' href: https://appdirect/api/marketplace/v1/products/640 edition: id: '1110' href: https://appdirect/api/marketplace/v1/products/640/editions/1110 redirectUrl: null customAttributes: - name: test1 values: - value1 - name: test2 values: - value2 - value3 application/xml: schema: $ref: '#/components/schemas/SubscriptionWS' '400': description: Bad Request '404': description: Subscription not found '412': description: The subscription cannot be updated x-codeSamples: - lang: Shell + Curl source: "curl --request PATCH \\\n --url https://marketplace.appdirect.com/api/billing/v1/subscriptions/%7BsubscriptionId%7D \\\n --header 'content-type: application/json' \\\n --data '{\"status\":\"SUSPENDED\",\"suspensionReasonMessage\":\"The customer is undergoing an internal investigation. All subscriptions are suspended.\",\"customAttributes\":[{\"name\":\"test1\",\"values\":[\"value1\"]},{\"name\":\"test2\",\"values\":[\"value2\",\"value3\"]}]}'" - lang: Node + Request source: "const request = require('request');\n\nconst options = {\n method: 'PATCH',\n url: 'https://marketplace.appdirect.com/api/billing/v1/subscriptions/%7BsubscriptionId%7D',\n headers: {'content-type': 'application/json'},\n body: {\n status: 'SUSPENDED',\n suspensionReasonMessage: 'The customer is undergoing an internal investigation. All subscriptions are suspended.',\n customAttributes: [\n {name: 'test1', values: ['value1']},\n {name: 'test2', values: ['value2', 'value3']}\n ]\n },\n json: true\n};\n\nrequest(options, function (error, response, body) {\n if (error) throw new Error(error);\n\n console.log(body);\n});\n" - lang: Java + Okhttp source: "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"status\\\":\\\"SUSPENDED\\\",\\\"suspensionReasonMessage\\\":\\\"The customer is undergoing an internal investigation. All subscriptions are suspended.\\\",\\\"customAttributes\\\":[{\\\"name\\\":\\\"test1\\\",\\\"values\\\":[\\\"value1\\\"]},{\\\"name\\\":\\\"test2\\\",\\\"values\\\":[\\\"value2\\\",\\\"value3\\\"]}]}\");\nRequest request = new Request.Builder()\n .url(\"https://marketplace.appdirect.com/api/billing/v1/subscriptions/%7BsubscriptionId%7D\")\n .patch(body)\n .addHeader(\"content-type\", \"application/json\")\n .build();\n\nResponse response = client.newCall(request).execute();" /billing/v1/subscriptions/{subscriptionId}/addons: get: description: Read addon instances for a subscription tags: - Subscriptions summary: Read addon instances for a subscription operationId: resource_Subscription_readAddonInstances_GET parameters: - description: Subscription ID name: subscriptionId in: path required: true schema: type: string - description: Search filter name: filter in: query schema: type: string - description: Sort field (UUID, DATE or STATUS) name: sortField in: query schema: type: string enum: - DATE - STATUS - UUID default: DATE - description: Sort order (ASC or DESC) name: sortOrder in: query schema: type: string enum: - ASC - DESC default: ASC responses: '200': description: OK content: application/json: schema: description: OK type: array items: $ref: '#/components/schemas/AddonInstanceWS' application/xml: schema: description: OK type: array items: $ref: '#/components/schemas/AddonInstanceWS' '404': description: Not Found x-codeSamples: - lang: Shell + Curl source: "curl --request GET \\\n --url 'https://marketplace.appdirect.com/api/billing/v1/subscriptions/%7BsubscriptionId%7D/addons?filter=SOME_STRING_VALUE&sortField=SOME_STRING_VALUE&sortOrder=SOME_STRING_VALUE'" - lang: Node + Request source: "const request = require('request');\n\nconst options = {\n method: 'GET',\n url: 'https://marketplace.appdirect.com/api/billing/v1/subscriptions/%7BsubscriptionId%7D/addons',\n qs: {\n filter: 'SOME_STRING_VALUE',\n sortField: 'SOME_STRING_VALUE',\n sortOrder: 'SOME_STRING_VALUE'\n }\n};\n\nrequest(options, function (error, response, body) {\n if (error) throw new Error(error);\n\n console.log(body);\n});\n" - lang: Java + Okhttp source: "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://marketplace.appdirect.com/api/billing/v1/subscriptions/%7BsubscriptionId%7D/addons?filter=SOME_STRING_VALUE&sortField=SOME_STRING_VALUE&sortOrder=SOME_STRING_VALUE\")\n .get()\n .build();\n\nResponse response = client.newCall(request).execute();" post: description: Create an add-on instance on the given subscription using the given data tags: - Subscriptions summary: Create an add-on instance operationId: resource_Subscription_createAddonInstance_POST parameters: - description: Subscription ID name: subscriptionId in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AddonInstanceWS' application/xml: schema: $ref: '#/components/schemas/AddonInstanceWS' description: Add-on instance object responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/AddonInstanceWS' examples: response: value: uuid: e472c043-9ef1-40c3-a751-261d82016228 offeringUuid: 39caa424-df16-48d8-8215-61fbb3aac327 units: 1 application/xml: schema: $ref: '#/components/schemas/AddonInstanceWS' '400': description: Bad Request '404': description: Not Found '409': description: Conflict x-codeSamples: - lang: Shell + Curl source: "curl --request POST \\\n --url https://marketplace.appdirect.com/api/billing/v1/subscriptions/%7BsubscriptionId%7D/addons \\\n --data '{\"creationDate\":12345,\"offeringUuid\":\"...\",\"order\":{\"_embedded\":{\"property1\":{},\"property2\":{}},\"activated\":true,\"company\":{\"href\":\"...\",\"id\":\"...\"},\"contract\":{},\"currency\":\"...\",\"customAttribute\":[{\"attributeType\":\"MULTISELECT\",\"name\":\"...\",\"value\":\"...\",\"valueKeys\":[\"...\",\"...\"]},{\"attributeType\":\"MULTISELECT\",\"name\":\"...\",\"value\":\"...\",\"valueKeys\":[\"...\",\"...\"]}],\"discount\":{\"href\":\"...\",\"id\":\"...\"},\"discountId\":12345,\"endDate\":12345,\"endOfDiscountDate\":12345,\"frequency\":\"...\",\"id\":12345,\"links\":[{\"href\":\"...\",\"rel\":\"...\"},{\"href\":\"...\",\"rel\":\"...\"}],\"nextBillingDate\":12345,\"nextOrder\":{\"href\":\"...\",\"id\":\"...\"},\"oneTimeOrder\":[{\"_embedded\":{\"property1\":{},\"property2\":{}},\"company\":{},\"currency\":\"...\",\"endDate\":12345,\"endOfDiscountDate\":12345,\"frequency\":\"...\",\"id\":12345,\"links\":[{},{}],\"nextBillingDate\":12345,\"paymentPlan\":{},\"referenceCode\":\"...\",\"salesSupportUser\":{},\"startDate\":12345,\"status\":\"...\",\"totalPrice\":12345,\"type\":\"...\",\"user\":{}},{\"_embedded\":{\"property1\":{},\"property2\":{}},\"company\":{},\"currency\":\"...\",\"endDate\":12345,\"endOfDiscountDate\":12345,\"frequency\":\"...\",\"id\":12345,\"links\":[{},{}],\"nextBillingDate\":12345,\"paymentPlan\":{},\"referenceCode\":\"...\",\"salesSupportUser\":{},\"startDate\":12345,\"status\":\"...\",\"totalPrice\":12345,\"type\":\"...\",\"user\":{}}],\"orderLine\":[{},{}],\"parameter\":[{\"name\":\"...\",\"value\":\"...\"},{\"name\":\"...\",\"value\":\"...\"}],\"paymentPlan\":{\"allowCustomUsage\":true,\"contract\":{},\"cost\":[{},{}],\"discount\":{},\"frequency\":\"...\",\"href\":\"...\",\"id\":12345,\"isPrimaryPrice\":true,\"keepBillDateOnUsageChange\":true,\"primaryPrice\":true,\"separatePrepaid\":true,\"tld\":\"...\",\"uuid\":\"...\"},\"paymentPlanId\":12345,\"previousOrder\":{\"href\":\"...\",\"id\":\"...\"},\"referenceCode\":\"...\",\"salesSupportUser\":{\"href\":\"...\",\"id\":\"...\"},\"startDate\":12345,\"status\":\"...\",\"totalPrice\":12345,\"type\":\"...\",\"user\":{\"href\":\"...\",\"id\":\"...\"}},\"status\":\"...\",\"units\":12345,\"uuid\":\"...\"}'" - lang: Node + Request source: "const request = require('request');\n\nconst options = {\n method: 'POST',\n url: 'https://marketplace.appdirect.com/api/billing/v1/subscriptions/%7BsubscriptionId%7D/addons',\n body: {\n creationDate: 12345,\n offeringUuid: '...',\n order: {\n _embedded: {property1: {}, property2: {}},\n activated: true,\n company: {href: '...', id: '...'},\n contract: {},\n currency: '...',\n customAttribute: [\n {\n attributeType: 'MULTISELECT',\n name: '...',\n value: '...',\n valueKeys: ['...', '...']\n },\n {\n attributeType: 'MULTISELECT',\n name: '...',\n value: '...',\n valueKeys: ['...', '...']\n }\n ],\n discount: {href: '...', id: '...'},\n discountId: 12345,\n endDate: 12345,\n endOfDiscountDate: 12345,\n frequency: '...',\n id: 12345,\n links: [{href: '...', rel: '...'}, {href: '...', rel: '...'}],\n nextBillingDate: 12345,\n nextOrder: {href: '...', id: '...'},\n oneTimeOrder: [\n {\n _embedded: {property1: {}, property2: {}},\n company: {},\n currency: '...',\n endDate: 12345,\n endOfDiscountDate: 12345,\n frequency: '...',\n id: 12345,\n links: [{}, {}],\n nextBillingDate: 12345,\n paymentPlan: {},\n referenceCode: '...',\n salesSupportUser: {},\n startDate: 12345,\n status: '...',\n totalPrice: 12345,\n type: '...',\n user: {}\n },\n {\n _embedded: {property1: {}, property2: {}},\n company: {},\n currency: '...',\n endDate: 12345,\n endOfDiscountDate: 12345,\n frequency: '...',\n id: 12345,\n links: [{}, {}],\n nextBillingDate: 12345,\n paymentPlan: {},\n referenceCode: '...',\n salesSupportUser: {},\n startDate: 12345,\n status: '...',\n totalPrice: 12345,\n type: '...',\n user: {}\n }\n ],\n orderLine: [{}, {}],\n parameter: [{name: '...', value: '...'}, {name: '...', value: '...'}],\n paymentPlan: {\n allowCustomUsage: true,\n contract: {},\n cost: [{}, {}],\n discount: {},\n frequency: '...',\n href: '...',\n id: 12345,\n isPrimaryPrice: true,\n keepBillDateOnUsageChange: true,\n primaryPrice: true,\n separatePrepaid: true,\n tld: '...',\n uuid: '...'\n },\n paymentPlanId: 12345,\n previousOrder: {href: '...', id: '...'},\n referenceCode: '...',\n salesSupportUser: {href: '...', id: '...'},\n startDate: 12345,\n status: '...',\n totalPrice: 12345,\n type: '...',\n user: {href: '...', id: '...'}\n },\n status: '...',\n units: 12345,\n uuid: '...'\n },\n json: true\n};\n\nrequest(options, function (error, response, body) {\n if (error) throw new Error(error);\n\n console.log(body);\n});\n" - lang: Java + Okhttp source: "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"creationDate\\\":12345,\\\"offeringUuid\\\":\\\"...\\\",\\\"order\\\":{\\\"_embedded\\\":{\\\"property1\\\":{},\\\"property2\\\":{}},\\\"activated\\\":true,\\\"company\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"},\\\"contract\\\":{},\\\"currency\\\":\\\"...\\\",\\\"customAttribute\\\":[{\\\"attributeType\\\":\\\"MULTISELECT\\\",\\\"name\\\":\\\"...\\\",\\\"value\\\":\\\"...\\\",\\\"valueKeys\\\":[\\\"...\\\",\\\"...\\\"]},{\\\"attributeType\\\":\\\"MULTISELECT\\\",\\\"name\\\":\\\"...\\\",\\\"value\\\":\\\"...\\\",\\\"valueKeys\\\":[\\\"...\\\",\\\"...\\\"]}],\\\"discount\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"},\\\"discountId\\\":12345,\\\"endDate\\\":12345,\\\"endOfDiscountDate\\\":12345,\\\"frequency\\\":\\\"...\\\",\\\"id\\\":12345,\\\"links\\\":[{\\\"href\\\":\\\"...\\\",\\\"rel\\\":\\\"...\\\"},{\\\"href\\\":\\\"...\\\",\\\"rel\\\":\\\"...\\\"}],\\\"nextBillingDate\\\":12345,\\\"nextOrder\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"},\\\"oneTimeOrder\\\":[{\\\"_embedded\\\":{\\\"property1\\\":{},\\\"property2\\\":{}},\\\"company\\\":{},\\\"currency\\\":\\\"...\\\",\\\"endDate\\\":12345,\\\"endOfDiscountDate\\\":12345,\\\"frequency\\\":\\\"...\\\",\\\"id\\\":12345,\\\"links\\\":[{},{}],\\\"nextBillingDate\\\":12345,\\\"paymentPlan\\\":{},\\\"referenceCode\\\":\\\"...\\\",\\\"salesSupportUser\\\":{},\\\"startDate\\\":12345,\\\"status\\\":\\\"...\\\",\\\"totalPrice\\\":12345,\\\"type\\\":\\\"...\\\",\\\"user\\\":{}},{\\\"_embedded\\\":{\\\"property1\\\":{},\\\"property2\\\":{}},\\\"company\\\":{},\\\"currency\\\":\\\"...\\\",\\\"endDate\\\":12345,\\\"endOfDiscountDate\\\":12345,\\\"frequency\\\":\\\"...\\\",\\\"id\\\":12345,\\\"links\\\":[{},{}],\\\"nextBillingDate\\\":12345,\\\"paymentPlan\\\":{},\\\"referenceCode\\\":\\\"...\\\",\\\"salesSupportUser\\\":{},\\\"startDate\\\":12345,\\\"status\\\":\\\"...\\\",\\\"totalPrice\\\":12345,\\\"type\\\":\\\"...\\\",\\\"user\\\":{}}],\\\"orderLine\\\":[{},{}],\\\"parameter\\\":[{\\\"name\\\":\\\"...\\\",\\\"value\\\":\\\"...\\\"},{\\\"name\\\":\\\"...\\\",\\\"value\\\":\\\"...\\\"}],\\\"paymentPlan\\\":{\\\"allowCustomUsage\\\":true,\\\"contract\\\":{},\\\"cost\\\":[{},{}],\\\"discount\\\":{},\\\"frequency\\\":\\\"...\\\",\\\"href\\\":\\\"...\\\",\\\"id\\\":12345,\\\"isPrimaryPrice\\\":true,\\\"keepBillDateOnUsageChange\\\":true,\\\"primaryPrice\\\":true,\\\"separatePrepaid\\\":true,\\\"tld\\\":\\\"...\\\",\\\"uuid\\\":\\\"...\\\"},\\\"paymentPlanId\\\":12345,\\\"previousOrder\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"},\\\"referenceCode\\\":\\\"...\\\",\\\"salesSupportUser\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"},\\\"startDate\\\":12345,\\\"status\\\":\\\"...\\\",\\\"totalPrice\\\":12345,\\\"type\\\":\\\"...\\\",\\\"user\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"}},\\\"status\\\":\\\"...\\\",\\\"units\\\":12345,\\\"uuid\\\":\\\"...\\\"}\");\nRequest request = new Request.Builder()\n .url(\"https://marketplace.appdirect.com/api/billing/v1/subscriptions/%7BsubscriptionId%7D/addons\")\n .post(body)\n .build();\n\nResponse response = client.newCall(request).execute();" /billing/v1/subscriptions/{subscriptionId}/invoices: get: description: List all of the invoices for the given subscription tags: - Subscriptions summary: List all invoices for a subscription operationId: resource_Subscription_readSubscriptionInvoices_GET parameters: - description: Subscription ID name: subscriptionId in: path required: true schema: type: string - description: Number of results to fetch. Used for paging. name: count in: query schema: type: integer default: 250 - description: Exclude invoices with no charges (free) name: excludeFree in: query schema: type: boolean - description: From date name: fromDate in: query schema: type: number - description: Sort field name: sortField in: query schema: type: string enum: - DATE - INVOICE_ID - TOTAL default: INVOICE_ID - description: Sort order name: sortOrder in: query schema: type: string enum: - ASC - DESC default: ASC - description: First result index. Used for paging. name: start in: query schema: type: integer default: 0 - description: Invoice status name: status in: query schema: type: string enum: - CARRIED - PAID - UNPAID - VOIDED - description: To date name: toDate in: query schema: type: number responses: '200': headers: X-Total-Count: schema: type: integer description: OK content: application/xml: schema: description: OK type: array items: $ref: '#/components/schemas/InvoiceListingWS' application/json: schema: description: OK type: array items: $ref: '#/components/schemas/InvoiceListingWS' examples: response: value: - invoiceId: 24 referenceNumber: null creationDate: 1480999442314 dueDate: 1481353200000 status: PAID total: 10 orderIds: - '2030' currency: USD user: id: f295b2f1-178f-46b4-a360-092011ad2946 href: http://appdirect/api/account/v1/users/f295b2f1-178f-46b4-a360-092011ad2946 company: id: d6190d63-3cae-4baa-a4ed-6e102c509178 href: http://appdirect/api/account/v1/companies/d6190d63-3cae-4baa-a4ed-6e102c509178 links: - rel: user href: http://appdirect/api/account/v2/users/f295b2f1-178f-46b4-a360-092011ad2946 - rel: company href: http://appdirect/api/account/v2/companies/d6190d63-3cae-4baa-a4ed-6e102c509178 - rel: self href: http://appdirect/api/billing/v1/invoices/24 headers: examples: response: value: X-Total-Count: 1 '404': description: Not Found x-codeSamples: - lang: Shell + Curl source: "curl --request GET \\\n --url 'https://marketplace.appdirect.com/api/billing/v1/subscriptions/%7BsubscriptionId%7D/invoices?count=SOME_INTEGER_VALUE&excludeFree=SOME_BOOLEAN_VALUE&fromDate=SOME_NUMBER_VALUE&sortField=SOME_STRING_VALUE&sortOrder=SOME_STRING_VALUE&start=SOME_INTEGER_VALUE&status=SOME_STRING_VALUE&toDate=SOME_NUMBER_VALUE'" - lang: Node + Request source: "const request = require('request');\n\nconst options = {\n method: 'GET',\n url: 'https://marketplace.appdirect.com/api/billing/v1/subscriptions/%7BsubscriptionId%7D/invoices',\n qs: {\n count: 'SOME_INTEGER_VALUE',\n excludeFree: 'SOME_BOOLEAN_VALUE',\n fromDate: 'SOME_NUMBER_VALUE',\n sortField: 'SOME_STRING_VALUE',\n sortOrder: 'SOME_STRING_VALUE',\n start: 'SOME_INTEGER_VALUE',\n status: 'SOME_STRING_VALUE',\n toDate: 'SOME_NUMBER_VALUE'\n }\n};\n\nrequest(options, function (error, response, body) {\n if (error) throw new Error(error);\n\n console.log(body);\n});\n" - lang: Java + Okhttp source: "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://marketplace.appdirect.com/api/billing/v1/subscriptions/%7BsubscriptionId%7D/invoices?count=SOME_INTEGER_VALUE&excludeFree=SOME_BOOLEAN_VALUE&fromDate=SOME_NUMBER_VALUE&sortField=SOME_STRING_VALUE&sortOrder=SOME_STRING_VALUE&start=SOME_INTEGER_VALUE&status=SOME_STRING_VALUE&toDate=SOME_NUMBER_VALUE\")\n .get()\n .build();\n\nResponse response = client.newCall(request).execute();" /billing/v1/subscriptions/{subscriptionId}/addons/preview: post: x-appdirect-visible: false description: Preview creation of an addon instance for a subscription tags: - Subscriptions summary: Preview creation of an addon instance for a subscription operationId: resource_Subscription_previewCreateAddonInstance_POST parameters: - description: Subscription ID name: subscriptionId in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AddonInstanceWS' application/xml: schema: $ref: '#/components/schemas/AddonInstanceWS' description: Payload of addon instance to create responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AddonInstanceWS' application/xml: schema: $ref: '#/components/schemas/AddonInstanceWS' '400': description: Bad Request '404': description: Subscription Not Found x-codeSamples: - lang: Shell + Curl source: "curl --request POST \\\n --url https://marketplace.appdirect.com/api/billing/v1/subscriptions/%7BsubscriptionId%7D/addons/preview \\\n --data '{\"creationDate\":12345,\"offeringUuid\":\"...\",\"order\":{\"_embedded\":{\"property1\":{},\"property2\":{}},\"activated\":true,\"company\":{\"href\":\"...\",\"id\":\"...\"},\"contract\":{},\"currency\":\"...\",\"customAttribute\":[{\"attributeType\":\"MULTISELECT\",\"name\":\"...\",\"value\":\"...\",\"valueKeys\":[\"...\",\"...\"]},{\"attributeType\":\"MULTISELECT\",\"name\":\"...\",\"value\":\"...\",\"valueKeys\":[\"...\",\"...\"]}],\"discount\":{\"href\":\"...\",\"id\":\"...\"},\"discountId\":12345,\"endDate\":12345,\"endOfDiscountDate\":12345,\"frequency\":\"...\",\"id\":12345,\"links\":[{\"href\":\"...\",\"rel\":\"...\"},{\"href\":\"...\",\"rel\":\"...\"}],\"nextBillingDate\":12345,\"nextOrder\":{\"href\":\"...\",\"id\":\"...\"},\"oneTimeOrder\":[{\"_embedded\":{\"property1\":{},\"property2\":{}},\"company\":{},\"currency\":\"...\",\"endDate\":12345,\"endOfDiscountDate\":12345,\"frequency\":\"...\",\"id\":12345,\"links\":[{},{}],\"nextBillingDate\":12345,\"paymentPlan\":{},\"referenceCode\":\"...\",\"salesSupportUser\":{},\"startDate\":12345,\"status\":\"...\",\"totalPrice\":12345,\"type\":\"...\",\"user\":{}},{\"_embedded\":{\"property1\":{},\"property2\":{}},\"company\":{},\"currency\":\"...\",\"endDate\":12345,\"endOfDiscountDate\":12345,\"frequency\":\"...\",\"id\":12345,\"links\":[{},{}],\"nextBillingDate\":12345,\"paymentPlan\":{},\"referenceCode\":\"...\",\"salesSupportUser\":{},\"startDate\":12345,\"status\":\"...\",\"totalPrice\":12345,\"type\":\"...\",\"user\":{}}],\"orderLine\":[{},{}],\"parameter\":[{\"name\":\"...\",\"value\":\"...\"},{\"name\":\"...\",\"value\":\"...\"}],\"paymentPlan\":{\"allowCustomUsage\":true,\"contract\":{},\"cost\":[{},{}],\"discount\":{},\"frequency\":\"...\",\"href\":\"...\",\"id\":12345,\"isPrimaryPrice\":true,\"keepBillDateOnUsageChange\":true,\"primaryPrice\":true,\"separatePrepaid\":true,\"tld\":\"...\",\"uuid\":\"...\"},\"paymentPlanId\":12345,\"previousOrder\":{\"href\":\"...\",\"id\":\"...\"},\"referenceCode\":\"...\",\"salesSupportUser\":{\"href\":\"...\",\"id\":\"...\"},\"startDate\":12345,\"status\":\"...\",\"totalPrice\":12345,\"type\":\"...\",\"user\":{\"href\":\"...\",\"id\":\"...\"}},\"status\":\"...\",\"units\":12345,\"uuid\":\"...\"}'" - lang: Node + Request source: "const request = require('request');\n\nconst options = {\n method: 'POST',\n url: 'https://marketplace.appdirect.com/api/billing/v1/subscriptions/%7BsubscriptionId%7D/addons/preview',\n body: {\n creationDate: 12345,\n offeringUuid: '...',\n order: {\n _embedded: {property1: {}, property2: {}},\n activated: true,\n company: {href: '...', id: '...'},\n contract: {},\n currency: '...',\n customAttribute: [\n {\n attributeType: 'MULTISELECT',\n name: '...',\n value: '...',\n valueKeys: ['...', '...']\n },\n {\n attributeType: 'MULTISELECT',\n name: '...',\n value: '...',\n valueKeys: ['...', '...']\n }\n ],\n discount: {href: '...', id: '...'},\n discountId: 12345,\n endDate: 12345,\n endOfDiscountDate: 12345,\n frequency: '...',\n id: 12345,\n links: [{href: '...', rel: '...'}, {href: '...', rel: '...'}],\n nextBillingDate: 12345,\n nextOrder: {href: '...', id: '...'},\n oneTimeOrder: [\n {\n _embedded: {property1: {}, property2: {}},\n company: {},\n currency: '...',\n endDate: 12345,\n endOfDiscountDate: 12345,\n frequency: '...',\n id: 12345,\n links: [{}, {}],\n nextBillingDate: 12345,\n paymentPlan: {},\n referenceCode: '...',\n salesSupportUser: {},\n startDate: 12345,\n status: '...',\n totalPrice: 12345,\n type: '...',\n user: {}\n },\n {\n _embedded: {property1: {}, property2: {}},\n company: {},\n currency: '...',\n endDate: 12345,\n endOfDiscountDate: 12345,\n frequency: '...',\n id: 12345,\n links: [{}, {}],\n nextBillingDate: 12345,\n paymentPlan: {},\n referenceCode: '...',\n salesSupportUser: {},\n startDate: 12345,\n status: '...',\n totalPrice: 12345,\n type: '...',\n user: {}\n }\n ],\n orderLine: [{}, {}],\n parameter: [{name: '...', value: '...'}, {name: '...', value: '...'}],\n paymentPlan: {\n allowCustomUsage: true,\n contract: {},\n cost: [{}, {}],\n discount: {},\n frequency: '...',\n href: '...',\n id: 12345,\n isPrimaryPrice: true,\n keepBillDateOnUsageChange: true,\n primaryPrice: true,\n separatePrepaid: true,\n tld: '...',\n uuid: '...'\n },\n paymentPlanId: 12345,\n previousOrder: {href: '...', id: '...'},\n referenceCode: '...',\n salesSupportUser: {href: '...', id: '...'},\n startDate: 12345,\n status: '...',\n totalPrice: 12345,\n type: '...',\n user: {href: '...', id: '...'}\n },\n status: '...',\n units: 12345,\n uuid: '...'\n },\n json: true\n};\n\nrequest(options, function (error, response, body) {\n if (error) throw new Error(error);\n\n console.log(body);\n});\n" - lang: Java + Okhttp source: "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"creationDate\\\":12345,\\\"offeringUuid\\\":\\\"...\\\",\\\"order\\\":{\\\"_embedded\\\":{\\\"property1\\\":{},\\\"property2\\\":{}},\\\"activated\\\":true,\\\"company\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"},\\\"contract\\\":{},\\\"currency\\\":\\\"...\\\",\\\"customAttribute\\\":[{\\\"attributeType\\\":\\\"MULTISELECT\\\",\\\"name\\\":\\\"...\\\",\\\"value\\\":\\\"...\\\",\\\"valueKeys\\\":[\\\"...\\\",\\\"...\\\"]},{\\\"attributeType\\\":\\\"MULTISELECT\\\",\\\"name\\\":\\\"...\\\",\\\"value\\\":\\\"...\\\",\\\"valueKeys\\\":[\\\"...\\\",\\\"...\\\"]}],\\\"discount\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"},\\\"discountId\\\":12345,\\\"endDate\\\":12345,\\\"endOfDiscountDate\\\":12345,\\\"frequency\\\":\\\"...\\\",\\\"id\\\":12345,\\\"links\\\":[{\\\"href\\\":\\\"...\\\",\\\"rel\\\":\\\"...\\\"},{\\\"href\\\":\\\"...\\\",\\\"rel\\\":\\\"...\\\"}],\\\"nextBillingDate\\\":12345,\\\"nextOrder\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"},\\\"oneTimeOrder\\\":[{\\\"_embedded\\\":{\\\"property1\\\":{},\\\"property2\\\":{}},\\\"company\\\":{},\\\"currency\\\":\\\"...\\\",\\\"endDate\\\":12345,\\\"endOfDiscountDate\\\":12345,\\\"frequency\\\":\\\"...\\\",\\\"id\\\":12345,\\\"links\\\":[{},{}],\\\"nextBillingDate\\\":12345,\\\"paymentPlan\\\":{},\\\"referenceCode\\\":\\\"...\\\",\\\"salesSupportUser\\\":{},\\\"startDate\\\":12345,\\\"status\\\":\\\"...\\\",\\\"totalPrice\\\":12345,\\\"type\\\":\\\"...\\\",\\\"user\\\":{}},{\\\"_embedded\\\":{\\\"property1\\\":{},\\\"property2\\\":{}},\\\"company\\\":{},\\\"currency\\\":\\\"...\\\",\\\"endDate\\\":12345,\\\"endOfDiscountDate\\\":12345,\\\"frequency\\\":\\\"...\\\",\\\"id\\\":12345,\\\"links\\\":[{},{}],\\\"nextBillingDate\\\":12345,\\\"paymentPlan\\\":{},\\\"referenceCode\\\":\\\"...\\\",\\\"salesSupportUser\\\":{},\\\"startDate\\\":12345,\\\"status\\\":\\\"...\\\",\\\"totalPrice\\\":12345,\\\"type\\\":\\\"...\\\",\\\"user\\\":{}}],\\\"orderLine\\\":[{},{}],\\\"parameter\\\":[{\\\"name\\\":\\\"...\\\",\\\"value\\\":\\\"...\\\"},{\\\"name\\\":\\\"...\\\",\\\"value\\\":\\\"...\\\"}],\\\"paymentPlan\\\":{\\\"allowCustomUsage\\\":true,\\\"contract\\\":{},\\\"cost\\\":[{},{}],\\\"discount\\\":{},\\\"frequency\\\":\\\"...\\\",\\\"href\\\":\\\"...\\\",\\\"id\\\":12345,\\\"isPrimaryPrice\\\":true,\\\"keepBillDateOnUsageChange\\\":true,\\\"primaryPrice\\\":true,\\\"separatePrepaid\\\":true,\\\"tld\\\":\\\"...\\\",\\\"uuid\\\":\\\"...\\\"},\\\"paymentPlanId\\\":12345,\\\"previousOrder\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"},\\\"referenceCode\\\":\\\"...\\\",\\\"salesSupportUser\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"},\\\"startDate\\\":12345,\\\"status\\\":\\\"...\\\",\\\"totalPrice\\\":12345,\\\"type\\\":\\\"...\\\",\\\"user\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"}},\\\"status\\\":\\\"...\\\",\\\"units\\\":12345,\\\"uuid\\\":\\\"...\\\"}\");\nRequest request = new Request.Builder()\n .url(\"https://marketplace.appdirect.com/api/billing/v1/subscriptions/%7BsubscriptionId%7D/addons/preview\")\n .post(body)\n .build();\n\nResponse response = client.newCall(request).execute();" /billing/v1/subscriptions/{subscriptionId}/addons/{addonInstanceUuid}/preview: put: x-appdirect-visible: false description: Preview change of an addon instance for a subscription tags: - Subscriptions summary: Preview change of an addon instance for a subscription operationId: resource_Subscription_previewChangeAddonInstance_PUT parameters: - name: addonInstanceUuid in: path required: true schema: type: string - description: Subscription ID name: subscriptionId in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AddonInstanceWS' application/xml: schema: $ref: '#/components/schemas/AddonInstanceWS' description: Payload of addon instance to create responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AddonInstanceWS' application/xml: schema: $ref: '#/components/schemas/AddonInstanceWS' '400': description: Bad Request '404': description: Subscription Not Found x-codeSamples: - lang: Shell + Curl source: "curl --request PUT \\\n --url https://marketplace.appdirect.com/api/billing/v1/subscriptions/%7BsubscriptionId%7D/addons/%7BaddonInstanceUuid%7D/preview \\\n --data '{\"creationDate\":12345,\"offeringUuid\":\"...\",\"order\":{\"_embedded\":{\"property1\":{},\"property2\":{}},\"activated\":true,\"company\":{\"href\":\"...\",\"id\":\"...\"},\"contract\":{},\"currency\":\"...\",\"customAttribute\":[{\"attributeType\":\"MULTISELECT\",\"name\":\"...\",\"value\":\"...\",\"valueKeys\":[\"...\",\"...\"]},{\"attributeType\":\"MULTISELECT\",\"name\":\"...\",\"value\":\"...\",\"valueKeys\":[\"...\",\"...\"]}],\"discount\":{\"href\":\"...\",\"id\":\"...\"},\"discountId\":12345,\"endDate\":12345,\"endOfDiscountDate\":12345,\"frequency\":\"...\",\"id\":12345,\"links\":[{\"href\":\"...\",\"rel\":\"...\"},{\"href\":\"...\",\"rel\":\"...\"}],\"nextBillingDate\":12345,\"nextOrder\":{\"href\":\"...\",\"id\":\"...\"},\"oneTimeOrder\":[{\"_embedded\":{\"property1\":{},\"property2\":{}},\"company\":{},\"currency\":\"...\",\"endDate\":12345,\"endOfDiscountDate\":12345,\"frequency\":\"...\",\"id\":12345,\"links\":[{},{}],\"nextBillingDate\":12345,\"paymentPlan\":{},\"referenceCode\":\"...\",\"salesSupportUser\":{},\"startDate\":12345,\"status\":\"...\",\"totalPrice\":12345,\"type\":\"...\",\"user\":{}},{\"_embedded\":{\"property1\":{},\"property2\":{}},\"company\":{},\"currency\":\"...\",\"endDate\":12345,\"endOfDiscountDate\":12345,\"frequency\":\"...\",\"id\":12345,\"links\":[{},{}],\"nextBillingDate\":12345,\"paymentPlan\":{},\"referenceCode\":\"...\",\"salesSupportUser\":{},\"startDate\":12345,\"status\":\"...\",\"totalPrice\":12345,\"type\":\"...\",\"user\":{}}],\"orderLine\":[{},{}],\"parameter\":[{\"name\":\"...\",\"value\":\"...\"},{\"name\":\"...\",\"value\":\"...\"}],\"paymentPlan\":{\"allowCustomUsage\":true,\"contract\":{},\"cost\":[{},{}],\"discount\":{},\"frequency\":\"...\",\"href\":\"...\",\"id\":12345,\"isPrimaryPrice\":true,\"keepBillDateOnUsageChange\":true,\"primaryPrice\":true,\"separatePrepaid\":true,\"tld\":\"...\",\"uuid\":\"...\"},\"paymentPlanId\":12345,\"previousOrder\":{\"href\":\"...\",\"id\":\"...\"},\"referenceCode\":\"...\",\"salesSupportUser\":{\"href\":\"...\",\"id\":\"...\"},\"startDate\":12345,\"status\":\"...\",\"totalPrice\":12345,\"type\":\"...\",\"user\":{\"href\":\"...\",\"id\":\"...\"}},\"status\":\"...\",\"units\":12345,\"uuid\":\"...\"}'" - lang: Node + Request source: "const request = require('request');\n\nconst options = {\n method: 'PUT',\n url: 'https://marketplace.appdirect.com/api/billing/v1/subscriptions/%7BsubscriptionId%7D/addons/%7BaddonInstanceUuid%7D/preview',\n body: {\n creationDate: 12345,\n offeringUuid: '...',\n order: {\n _embedded: {property1: {}, property2: {}},\n activated: true,\n company: {href: '...', id: '...'},\n contract: {},\n currency: '...',\n customAttribute: [\n {\n attributeType: 'MULTISELECT',\n name: '...',\n value: '...',\n valueKeys: ['...', '...']\n },\n {\n attributeType: 'MULTISELECT',\n name: '...',\n value: '...',\n valueKeys: ['...', '...']\n }\n ],\n discount: {href: '...', id: '...'},\n discountId: 12345,\n endDate: 12345,\n endOfDiscountDate: 12345,\n frequency: '...',\n id: 12345,\n links: [{href: '...', rel: '...'}, {href: '...', rel: '...'}],\n nextBillingDate: 12345,\n nextOrder: {href: '...', id: '...'},\n oneTimeOrder: [\n {\n _embedded: {property1: {}, property2: {}},\n company: {},\n currency: '...',\n endDate: 12345,\n endOfDiscountDate: 12345,\n frequency: '...',\n id: 12345,\n links: [{}, {}],\n nextBillingDate: 12345,\n paymentPlan: {},\n referenceCode: '...',\n salesSupportUser: {},\n startDate: 12345,\n status: '...',\n totalPrice: 12345,\n type: '...',\n user: {}\n },\n {\n _embedded: {property1: {}, property2: {}},\n company: {},\n currency: '...',\n endDate: 12345,\n endOfDiscountDate: 12345,\n frequency: '...',\n id: 12345,\n links: [{}, {}],\n nextBillingDate: 12345,\n paymentPlan: {},\n referenceCode: '...',\n salesSupportUser: {},\n startDate: 12345,\n status: '...',\n totalPrice: 12345,\n type: '...',\n user: {}\n }\n ],\n orderLine: [{}, {}],\n parameter: [{name: '...', value: '...'}, {name: '...', value: '...'}],\n paymentPlan: {\n allowCustomUsage: true,\n contract: {},\n cost: [{}, {}],\n discount: {},\n frequency: '...',\n href: '...',\n id: 12345,\n isPrimaryPrice: true,\n keepBillDateOnUsageChange: true,\n primaryPrice: true,\n separatePrepaid: true,\n tld: '...',\n uuid: '...'\n },\n paymentPlanId: 12345,\n previousOrder: {href: '...', id: '...'},\n referenceCode: '...',\n salesSupportUser: {href: '...', id: '...'},\n startDate: 12345,\n status: '...',\n totalPrice: 12345,\n type: '...',\n user: {href: '...', id: '...'}\n },\n status: '...',\n units: 12345,\n uuid: '...'\n },\n json: true\n};\n\nrequest(options, function (error, response, body) {\n if (error) throw new Error(error);\n\n console.log(body);\n});\n" - lang: Java + Okhttp source: "OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\\"creationDate\\\":12345,\\\"offeringUuid\\\":\\\"...\\\",\\\"order\\\":{\\\"_embedded\\\":{\\\"property1\\\":{},\\\"property2\\\":{}},\\\"activated\\\":true,\\\"company\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"},\\\"contract\\\":{},\\\"currency\\\":\\\"...\\\",\\\"customAttribute\\\":[{\\\"attributeType\\\":\\\"MULTISELECT\\\",\\\"name\\\":\\\"...\\\",\\\"value\\\":\\\"...\\\",\\\"valueKeys\\\":[\\\"...\\\",\\\"...\\\"]},{\\\"attributeType\\\":\\\"MULTISELECT\\\",\\\"name\\\":\\\"...\\\",\\\"value\\\":\\\"...\\\",\\\"valueKeys\\\":[\\\"...\\\",\\\"...\\\"]}],\\\"discount\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"},\\\"discountId\\\":12345,\\\"endDate\\\":12345,\\\"endOfDiscountDate\\\":12345,\\\"frequency\\\":\\\"...\\\",\\\"id\\\":12345,\\\"links\\\":[{\\\"href\\\":\\\"...\\\",\\\"rel\\\":\\\"...\\\"},{\\\"href\\\":\\\"...\\\",\\\"rel\\\":\\\"...\\\"}],\\\"nextBillingDate\\\":12345,\\\"nextOrder\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"},\\\"oneTimeOrder\\\":[{\\\"_embedded\\\":{\\\"property1\\\":{},\\\"property2\\\":{}},\\\"company\\\":{},\\\"currency\\\":\\\"...\\\",\\\"endDate\\\":12345,\\\"endOfDiscountDate\\\":12345,\\\"frequency\\\":\\\"...\\\",\\\"id\\\":12345,\\\"links\\\":[{},{}],\\\"nextBillingDate\\\":12345,\\\"paymentPlan\\\":{},\\\"referenceCode\\\":\\\"...\\\",\\\"salesSupportUser\\\":{},\\\"startDate\\\":12345,\\\"status\\\":\\\"...\\\",\\\"totalPrice\\\":12345,\\\"type\\\":\\\"...\\\",\\\"user\\\":{}},{\\\"_embedded\\\":{\\\"property1\\\":{},\\\"property2\\\":{}},\\\"company\\\":{},\\\"currency\\\":\\\"...\\\",\\\"endDate\\\":12345,\\\"endOfDiscountDate\\\":12345,\\\"frequency\\\":\\\"...\\\",\\\"id\\\":12345,\\\"links\\\":[{},{}],\\\"nextBillingDate\\\":12345,\\\"paymentPlan\\\":{},\\\"referenceCode\\\":\\\"...\\\",\\\"salesSupportUser\\\":{},\\\"startDate\\\":12345,\\\"status\\\":\\\"...\\\",\\\"totalPrice\\\":12345,\\\"type\\\":\\\"...\\\",\\\"user\\\":{}}],\\\"orderLine\\\":[{},{}],\\\"parameter\\\":[{\\\"name\\\":\\\"...\\\",\\\"value\\\":\\\"...\\\"},{\\\"name\\\":\\\"...\\\",\\\"value\\\":\\\"...\\\"}],\\\"paymentPlan\\\":{\\\"allowCustomUsage\\\":true,\\\"contract\\\":{},\\\"cost\\\":[{},{}],\\\"discount\\\":{},\\\"frequency\\\":\\\"...\\\",\\\"href\\\":\\\"...\\\",\\\"id\\\":12345,\\\"isPrimaryPrice\\\":true,\\\"keepBillDateOnUsageChange\\\":true,\\\"primaryPrice\\\":true,\\\"separatePrepaid\\\":true,\\\"tld\\\":\\\"...\\\",\\\"uuid\\\":\\\"...\\\"},\\\"paymentPlanId\\\":12345,\\\"previousOrder\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"},\\\"referenceCode\\\":\\\"...\\\",\\\"salesSupportUser\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"},\\\"startDate\\\":12345,\\\"status\\\":\\\"...\\\",\\\"totalPrice\\\":12345,\\\"type\\\":\\\"...\\\",\\\"user\\\":{\\\"href\\\":\\\"...\\\",\\\"id\\\":\\\"...\\\"}},\\\"status\\\":\\\"...\\\",\\\"units\\\":12345,\\\"uuid\\\":\\\"...\\\"}\");\nRequest request = new Request.Builder()\n .url(\"https://marketplace.appdirect.com/api/billing/v1/subscriptions/%7BsubscriptionId%7D/addons/%7BaddonInstanceUuid%7D/preview\")\n .put(body)\n .build();\n\nResponse response = client.newCall(request).execute();" /billing/v1/subscriptions/{subscriptionId}/previewCancel: get: description: Preview a subscription cancellation for the given subscription ID tags: - Subscriptions summary: Preview subscription cancellation operationId: resource_Subscription_previewCancelSubscription_GET parameters: - description: The subscription ID name: subscriptionId in: path required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SubscriptionWS' examples: response: value: id: 08e230e5-2895-478f-aaeb-3879f5fe5c33 creationDate: 1480999441698 endDate: null externalAccountId: 12-account-identifier status: ACTIVE maxUsers: 0 assignedUsers: 1 order: startDate: 1480999441682 endDate: null nextBillingDate: 1483677841682 endOfDiscountDate: null status: ACTIVE frequency: MONTHLY currency: USD type: NEW totalPrice: 0 user: id: 69474681-db96-4486-8954-34d12c23e415 href: http://appdirect/api/account/v1/users/69474681-db96-4486-8954-34d12c23e415 salesSupportUser: null company: id: 1a32fa08-839f-4594-9003-aa4081c84fff href: http://appdirect/api/account/v1/companies/1a32fa08-839f-4594-9003-aa4081c84fff referenceCode: null paymentPlan: href: http://appdirect/api/marketplace/v1/products/8/editions/11/paymentPlans/18 id: 18 uuid: feed23e0-de8c-4e6f-b70a-13b0f610b0f7 frequency: MONTHLY contract: minimumServiceLength: 3 cancellationPeriodLimit: null endOfContractGracePeriod: null blockSwitchToShorterContract: false blockContractDowngrades: false blockContractUpgrades: false alignWithParentCycleStartDate: false gracePeriod: null terminationFee: null autoExtensionPricingId: 18 allowCustomUsage: false keepBillDateOnUsageChange: false separatePrepaid: false isPrimaryPrice: false costs: - id: 18 unit: USER unitDependency: null minUnits: 0 maxUnits: null meteredUsage: false increment: 1 pricePerIncrement: false blockContractDecrease: false blockContractIncrease: false blockOriginalContractDecrease: false amount: USD: 10 pricingStrategy: UNIT discount: null primaryPrice: false contract: minimumServiceLength: 24 endOfContractDate: 1588789800000 gracePeriodEndDate: null cancellationPeriodLimit: null endOfContractGracePeriod: null terminationFee: type: PERCENTAGE description: Fee percentage: 100 price: null estimatedCost: 254.6628 renewal: null previousOrder: null nextOrder: null discount: null paymentPlanId: 18 discountId: null activated: false oneTimeOrders: [] orderLines: [] parameters: [] links: - rel: subscription href: http://appdirect/api/billing/v1/subscriptions/08e230e5-2895-478f-aaeb-3879f5fe5c33 id: 12 upcomingOrder: null user: id: 69474681-db96-4486-8954-34d12c23e415 href: http://appdirect/api/account/v1/users/69474681-db96-4486-8954-34d12c23e415 company: id: 1a32fa08-839f-4594-9003-aa4081c84fff href: http://appdirect/api/account/v1/companies/1a32fa08-839f-4594-9003-aa4081c84fff product: id: '8' href: http://appdirect/api/marketplace/v1/products/8 edition: id: '11' href: http://appdirect/api/marketplace/v1/products/8/editions/11 redirectUrl: null application/xml: schema: $ref: '#/components/schemas/SubscriptionWS' '404': description: Not Found x-codeSamples: - lang: Shell + Curl source: "curl --request GET \\\n --url https://marketplace.appdirect.com/api/billing/v1/subscriptions/%7BsubscriptionId%7D/previewCancel" - lang: Node + Request source: "const request = require('request');\n\nconst options = {\n method: 'GET',\n url: 'https://marketplace.appdirect.com/api/billing/v1/subscriptions/%7BsubscriptionId%7D/previewCancel'\n};\n\nrequest(options, function (error, response, body) {\n if (error) throw new Error(error);\n\n console.log(body);\n});\n" - lang: Java + Okhttp source: "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://marketplace.appdirect.com/api/billing/v1/subscriptions/%7BsubscriptionId%7D/previewCancel\")\n .get()\n .build();\n\nResponse response = client.newCall(request).execute();" /api/v1/org-subscriptions/{publicId}: get: tags: - Subscriptions summary: Get an organization subscription by public ID description: Retrieves an organization subscription by its public subscription identifier. Callers must have organization, tenant, or instance-level read permission on organization subscriptions. When that requirement is met, the subscription is returned only if it exists and the caller is permitted to read that specific subscription; otherwise the API responds with 404 so clients cannot infer whether a given public ID exists. operationId: getOrgSubscriptionByPublicId parameters: - name: publicId in: path required: true description: Public subscription identifier. schema: type: string minLength: 1 responses: '200': description: Organization subscription details. content: application/json: schema: $ref: '#/components/schemas/OrgSubscriptionDto' '400': description: Invalid public subscription identifier. '403': description: Forbidden. The caller does not have organization, tenant, or instance-level permission to read organization subscriptions, so this endpoint cannot be used. '404': description: No subscription is returned. This status is used for an unknown public ID, no matching subscription, or when the caller is not allowed to read the requested subscription (same response shape in the latter case to avoid revealing whether the subscription exists). security: - ApiKeyAuth: [] components: schemas: OrgSubscriptionStatusDto: type: string enum: - ACTIVE - CANCELLED - SUSPENDED - FREE_TRIAL OrderContractWS: type: object title: OrderContract properties: minimumServiceLength: description: Minimum service length of contract type: number endOfContractDate: description: End date for contract type: number gracePeriodEndDate: description: End date for grace period type: number nullable: true cancellationPeriodLimit: description: Cancellation period limit type: number nullable: true endOfContractGracePeriod: description: Grace period for end of contract type: number nullable: true terminationFee: $ref: '#/components/schemas/OrderTerminationFeeWS' renewal: $ref: '#/components/schemas/OrderContractRenewalWS' autoExtensionPricingUuid: description: The edition pricing ID to which to bind the contract when it is automatically renewed. To retrieve the value, use the "uuid" value from the "Read payment plan" https://help.appdirect.com/api/appdirect.html#read-payment-plan request. type: string nullable: true continueWithoutContract: description: Determines whether to continue the subscription without a contract type: boolean blockContractUpgrades: description: Determines whether to block upgrades to the contract terms type: boolean blockContractDowngrades: description: Determines whether to block downgrades to the contract terms type: boolean blockSwitchToShorterContract: description: Determines whether to block the ability to switch to a shorter contract type: boolean keepContractDateOnPlanChange: description: Determines whether to keep the contract date if the plan changes type: boolean alignWithParentCycleStartDate: description: For add-on products, determines whether to align the contract start date with the parent subscription start date. This is an internal setting. type: boolean unitTerms: description: List of contract unit terms type: array items: $ref: '#/components/schemas/OrderUnitContractWS' example: cancellationPeriodLimit: null endOfContractDate: 1588789800000 endOfContractGracePeriod: null gracePeriodEndDate: null minimumServiceLength: 24 renewal: null terminationFee: description: Fee estimatedCost: 254.6628 percentage: 100 price: null type: PERCENTAGE autoExtensionPricingUuid: 0a12c84d-984f-4f64-943b-8e6f47a28d55 continueWithoutContract: true blockContractUpgrades: false blockContractDowngrades: true blockSwitchToShorterContract: true keepContractDateOnPlanChange: false alignWithParentCycleStartDate: true unitTerms: - unit: USER blockContractIncrease: true blockOriginalContractDecrease: false blockContractDecrease: false nullable: true OrderContractRenewalWS: type: object title: OrderContractRenewalWS properties: order: $ref: '#/components/schemas/LinkWS' paymentPlan: $ref: '#/components/schemas/PaymentPlanWS' example: order: href: '...' id: '...' paymentPlan: allowCustomUsage: true contract: {} cost: - {} - {} discount: {} frequency: '...' href: '...' id: 12345 isPrimaryPrice: true keepBillDateOnUsageChange: true primaryPrice: true separatsePrepaid: true tld: '...' uuid: '...' nullable: true SubscriptionMetadataDto: type: object additionalProperties: true properties: trialEndDate: type: string format: date-time promo: type: string ProductDiscountDetailsWS: description: Discount detail on a product pricing type: object title: ProductDiscountDetails properties: amount: $ref: '#/components/schemas/PriceWS' availableRedemptions: description: Number of time the discount can be used type: number description: description: Description type: string nullable: true expirationDate: description: Expiration date of the discount type: number numOfBillingCycles: description: Number of billing cycle the discount is applicable type: number percentage: description: Discount in percentage type: number pricingUnit: $ref: '#/components/schemas/PricingUnit' startDate: description: Start date of the discount type: number example: amount: AUD: 12345 BRL: 12345 CAD: 12345 CHF: 12345 CNY: 12345 DKK: 12345 EUR: 12345 GBP: 12345 GTQ: 12345 INR: 12345 JPY: 12345 KRW: 12345 MXN: 12345 MYR: 12345 NOK: 12345 NZD: 12345 PHP: 12345 SAR: 12345 SEK: 12345 SGD: 12345 USD: 12345 ZAR: 12345 availableRedemptions: 12345 description: '...' expirationDate: 12345 numOfBillingCycles: 12345 percentage: 12345 pricingUnit: TIER3_STANDARD_LINE startDate: 12345 nullable: true AttributeType: type: string title: AttributeType enum: - TEXT - MULTISELECT PricingUnit: type: string title: PricingUnit enum: - USER - GIGABYTE - GMV - MEGABYTE - PROSPECT_SCORE - HOUR - MINUTE - INVOICE - UNIT - PROJECT - PROPERTY - ITEM - WORD - EMAIL - CONTACT - CALL - CREDIT - ROOM - HOST - AGENT - OPERATOR - PROVIDER - MANAGER - TESTER - JVM - SERVER - WEB_USE_MINUTE - AUDIO_USE_MINUTE - PIECE - EMPLOYEE_PAY_PERIOD - EMPLOYEE_PER_PAY_PERIOD - COMPUTER - NOT_APPLICABLE - ONE_TIME_SETUP - DATA_POINTS - TIER1_API_CALLS - TIER2_API_CALLS - ADVISORY_HOURS - OVERAGE_AUDIO_MINUTE - EMPLOYEE - CONNECTION - PUSH_USER - THOUSAND_EMAILS_PER_DAY - PUSH_NOTIFICATION_DEVICES - API_CALLS - SMS_TEXT_MESSAGE - CONTACTS_1000 - CONTRACT_FEE - TRANSFER_FEE - REACTIVATION_FEE - RECIPIENT - ADDITIONAL_1000_CONTACTS_BLOCK - SCHEDULE_PLAN - EMAILS_1000 - EMAILS_2500 - EMAILS_100000 - MOBILE_DEVICE - PAYSLIP - PAYSLIP_CORRECTION - STORE - WEBSITE - EPAPER - PAGE - POSTAGE_AND_PRINT - INTERNATIONAL_POSTAGE_AND_PRINT - TIER1_TOP_LEVEL_DOMAIN - TIER2_TOP_LEVEL_DOMAIN - DEDICATED_IP - ENABLELCM - MAXCOMPONENTS - DATA_MANAGEMENT_USER - SPECIALIST_USER - PROFESSIONAL_USER - MATERIALITY_MATRIX - STAKEHOLDER_MANAGEMENT - SCORECARD - STANDARD_MAPPING - DONATION_MANAGEMENT - DOCUMENT - PACKAGE_SMALL - PACKAGE_LARGE - MEMBER - ATTENDEE - MAILING - RESPONSE - EXTERNAL_INVOICE_FEE - CLIENT_TEST - IMAGE_TRANSFORMATION - TOTAL_IMAGE - LICENSE - MAILBOX - FREE_40_INCH_HDTV_PC - FREE_46_INCH_HDTV_PC - FREE_46_INCH_HDTV_PC_MOUNTING - EMPLOYEE_PER_WEEK - REGISTER - END_USER - CORE - DEVICE - PORT - MEASURER - PUBLISHED_MEASUREMENT - NODE - SERVER_RULE - VPN_LP - PROXY_LP - DESKTOP_CONNECT_LP - CAMERA - MAIN_SOUND_ZONE - SUB_SOUND_ZONE - POST - REPORT - BOX - SESSION - DISPLAY - TRUCKROLL - TRANSACTION_FEE - SENDING_API_CALL - LOOKUP_API_CALL - ANALYTICS_API_CALL - MIGRATION_INSTANCE - NFON_SETUP_PER_PHONE_EXTENSION - NFON_SETUP_PER_PHONE_EXTENSION_PLUS - NFON_SETUP_PER_EFAX_EXTENSION - NFON_PHONE_EXTENSION - NFON_PHONE_EXTENSION_PLUS - NFON_EFAX_EXTENSION - NFON_CALL_CENTER_MONITORING - NFON_NMEETING - NFON_MOBILE_NFON_DEVICE - NFON_ISOFTPHONE_MAC - NFON_NSOFTPHONE_STANDARD_WINDOWS - NFON_NSOFTPHONE_PREMIUM_WINDOWS - NFON_NCTI_STANDARD_WINDOWS - NFON_NCTI_STANDARD_CRM_WINDOWS - NFON_NCTI_STANDARD_MAC - NFON_NSOFTPHONE_STANDARD_WINDOWS_OR_MOBILE - WESUSTAIN_PERFORMANCE - WESUSTAIN_STAKEHOLDER_REPUTATION - WESUSTAIN_WEAPP - FAX - FAX_LINE - ROOM_LINE - DEPARTMENT_LINE - INTERNATIONAL_LICENSE - INTERNATIONAL_DEPARTMENT_LINE - INTERNATIONAL_ROOM_LINE - INTERNATIONAL_LINE - CALLING_CREDIT - LINE - TOLLFREE_ROOM_LINE - TOLLFREE_DEPARTMENT_LINE - TAXES_AND_FEES - LEAD - OPPORTUNITY - CAMPAIGN - CASE - CUSTOMER - TIER1_STANDARD_LINE - TIER1_ROOM_LINE - TIER1_TOLLFREE_ROOM_LINE - TIER1_TOLLFREE_DEPARTMENT_LINE - TIER1_FAX_LINE - TIER1_DEPARTMENT_LINE - TIER2_STANDARD_LINE - TIER2_ROOM_LINE - TIER2_DEPARTMENT_LINE - TIER3_STANDARD_LINE - TIER3_ROOM_LINE - TIER3_DEPARTMENT_LINE - TIER4_STANDARD_LINE - TIER4_ROOM_LINE - TIER4_DEPARTMENT_LINE - CLUSTER - NODE_4VCPU - FIVE_HUNDRED_GB_SSD - TWELVE_TB_NETWORK_IO - JBOSS_EAP - JBOSS_FUSE - JBOSS_A_MQ - JBOSS_BRMS - JBOSS_BPM_SUITE - JBOSS_DATA_GRID - JBOSS_DATA_VIRT - USER_LICENSE - ADDITIONAL_NUMBER_LICENSE - ROOM_PHONE_LICENSE - UBERCONFERENCE_PRO_LICENSE - UBERCONFERENCE_PRO_LICENSE_UNBUNDLED - INSTANCE - INDOOR_CAMERA - OUTDOOR_CAMERA - VINGATE_LP_LICENCE - ADMINISTRATOR - MOBILE_USER - G_SUITE - T1 - PHONE - AUTO_ATTENDANT - HUNT_GROUP - VOICEMAIL_BOX - TOLL_FREE_NUMBER - INBOUND_LONG_DISTANCE_MINUTE - OUTBOUND_LONG_DISTANCE_MINUTE - INBOUND_OUTBOUND_LONG_DISTANCE_MINUTE - SET_TOP_BOX - MODEM - ACCESS_POINT - CALLING_FEATURE - IAD_DEVICE - ANALOG_LINE - PRI - SBC_DEVICE - ROUTER - INTERNATIONAL_MINUTE - PHONE_LINE - DYNAMIC_IP_ADDRESS - STATIC_IP_ADDRESS - GATEWAY - REMOTE_CONTROL - TIER1_STANDARD_SEAT - TIER2_STANDARD_SEAT - TIER3_STANDARD_SEAT - TIER4_STANDARD_SEAT - TIER1_TOLL_FREE_SEAT - MILLION_MESSAGES - MESSAGE - WEEKLY - PHONE_NUMBER - GUEST - REVISION_SAFE_DATAROOM - GROUP_SESSION - MAILBOX_AD_SYNC - PHONE_SUPPORT - EXTRA_10TB - EXTRA_50TB - EXTRA_200TB - MAP_VIEW - SVM - CHANNEL - NUMBER_PRINTER_TABLET - NUMBER_ONSITE_SERVER - NUMBER_VISITS - ONSITE_TECHNICIAN_PC - ONSITE_TECHNICIAN_SERVER - SHORTER_REACTION_TIMES - E_COMMERCE_INTEGRATION - LOCATION - TRAINING_SESSION - GIGABYTES_PER_HOUR - FINANCIAL_PLANNING - ONSITE_WORKPLACE - INTERNAL_TOOLS_ACCESS - DUTY_SERVICE - TERABYTE - HOST_UNIT_HOURS - WEB_CHECKS - ACTIVE_USERS - ACTIVE_EMPLOYEE - PC_OF_NET_RECURRING_FEE - ACTIVE_VENDOR - ADVERTISEMENT - ADVERTISER_SPENDS - ANNUAL_FUNDRAISING_INCOME - ANNUAL_SUBSCRIPTION - APPLIANCE - ASSET - ASSETS_UNDER_MANAGEMENT - BUSINESS_PARTNERS - CASH_FLOWS - COMPONENT - CONNECTED_SYSTEMS - CONTRACTS - COSTS - DATA_STREAMS - DATABASE_SIZE - EXTERNAL_SERVICE_CALLS - FILE - FIXED - FLAT - FLAT_FEE_BASED_ON_ASSETS - FLEET_PLANNING_ORDERS - FORMS - GIGABYTE_DATABASE_SIZES - INSTALLATION - INSTALLED_CAPACITY - JOB_POSTING - LEARNER - LOGON - MANAGED_SYSTEM - MASTER_DATA_OBJECT - MASTER_RECORDS - MBPS - MONITORED_USER - MPLS - ORDER - OUTPATIENT_DAYS - PAGE_VIEW - PATIENT_CARE_DAY - PATIENT_TREATED - PLANT - POINTS_OF_DELIVERY - PREMIUM - PROCESS - PRODUCTS - RECORDS - RENTAL_UNIT - RESOURCES - REVENUE - SALES_ORDER - SALES_PORTFOLIOS - SERVICE_ORDERS - SITE_VISITS - SPENDS - SPEND_VOLUMES - STREAM - STUDENT - SUBSCRIBER - SUPPLIERS - TICKETS - TOTAL_ANNUAL_BUDGET - TUNNEL - VIRTUAL_USERS - SAP_SYSTEM - POSITION_TYPES - OVERAGE_FEES - OVERAGE_FEE_TRANSACTION - OVERAGE_FEES_DOCUMENT - OVERAGE_FEES_ITEM - EVENT - BUSINESS_EVENT - LEGAL_TENDER - ANNUAL_REVENUE - AD_SYNC - FULL_DATA_RESTORE - USED_STORAGE_100GB - COMPANY - ADDITIONAL_USER - VISIT - VIDEO - ELECTRONIC_PAYMENT - CHECK_PAYMENT - EXPRESS_PAY_ELECTRONIC_PAYMENT - EXPRESS_PAY_CHECK_PAYMENT - DATA_ENTRY_SERVICE - MONTHLY_VISIT - SCRUB_TRANSACTION - DEVICE_LICENSE - SERVER_LICENSE - BASE_LICENSE - SERVICE_CALL - SUPPORT_INCIDENT_TICKET - CUSTOM_REPORT_BUILDING_TRAINING - QUOTA - DOMESTIC_TRANSACTION - BEE - BEE_FLEET - BEE_BEACON_AMBIENT_LIGHT - BEE_BEACON_TEMPERATURE_HUMIDITY - CONTACTS_100 - TEMPLATE - TEMPLATE_PACKS_10 - PACK - SMS_TEXT_MESSAGE_10 - VIRTUAL_SERVER - PHYSICAL_SERVER - WORKSTATION - CHATS - MATCH_LIST - CERTIFICATE_12_MONTHS - CERTIFICATE_24_MONTHS - PRIVACY - PAGE_VIEWS_100000 - VOICE_OUT - EXAM - PARTICIPANT - ENCRYPTION_ADDON - ESS - ETI - ATP_ADDON - PBE_ADDO - NETI_ADDON - HUNDRED_SMS_REMINDER - CALENDAR_SYNC - PAYMENT_INTERFACE - MULTILINGUAL_ONLINE_EVENT_BOOKING - SOCKET - OFFER - FREELANCER - SOAP - DATEV_LEXWARE_INTERFACE - TOKEN - SERVICE_MONTH - VIDEO_PACKAGE_50_HOURS - INTERFACE - TEST_CASE - MINUTES_15 - MINUTES_30 - CONNECTED_ACCESS_POINT - DAY - SATURDAY_SURCHARGE - NIGHT_SURCHARGE - SUNDAY_SURCHARGE - PUBLIC_HOLIDAY_SURCHARGE - BASIC_PACKAGE - STANDARD_PACKAGE - PREMIUM_PACKAGE - REPORTS_MODULE - WORKFLOW_MODULE - NBV_250K - NBV - INVENTORY - ADDITIONAL_COMPANY - TRANSACTION - PREMIUM_CREDIT_REPORTS - ADDITIONAL_CONNECTION - STOCK_UNIT - MONTHLY_USAGE_FEE - USAGE_FEE - MONTHLY_CHARGES - STANDARD_USER - ADDITIONAL_UNIT - COMMISSION - KITTING - WOP - SFDC - NAMED_USER_LICENSE - BARCODING_AND_WAREHOUSING - MODULE - MANUFACTURING_MODULE - MRP - CONSOLE_MODULE - CONSOLIDATIONS - MULTI_CURRENCY - ADDON_LICENSE - INBOUND_PAGE - OUTBOUND_PAGE - OPPORTUNITY_RETENTION - SOCIAL_SENTIMENT - DEMAND_PRICE - SETUP_FEE - SHAREPOINT - INTEGRATION_MAINTENANCE - VIEWER - MANAGEMENT_USER - SQ_FT - LOCATION_UPTO_10_EMPLOYEES - LOCATION_UPTO_20_EMPLOYEES - LOCATION_UPTO_30_EMPLOYEES - LOCATION_UPTO_60_EMPLOYEES - LOCATION_UPTO_99_EMPLOYEES - M365_ONLINE - WEB_HOSTING_SERVER - STANDARD_EDITION_GIGABYTE - STORAGE_GIGABYTE - EGRESS_GIGABYTE - FEE_HW_DEFECT_NO_WARRANTY_CASE - SIM_CARD - SIM_CARDS_10 - APPLICATION_CONNECTOR - ADDITIONAL_API_CALLS - USED_STORAGE_PER_GB - CERTIFICATION - MACHINE - CALCULATION_USER - MAILBOX_S - MAILBOX_M - MAILBOX_L - STORAGE - GROUP - VEHICLE - ENDPOINT - MANAGED_SERVICE - SOC - ONLINE_PLAN - ENTERPRISE_PLAN - FLOATING_LICENSE - USER_PER_LICENSE - CONCURRENT_USER_PER_LICENSE - DASHBOARD - IT_INTERFACE - CONNECTABLE_IOT_DEVICE_VIA_USB - CONNECTABLE_IOT_DEVICE_VIA_TULIP_GATEWAY - CONNECTABLE_MACHINE_PER_LICENSE - OBJECT_TO_BE_CHECKED - MACHINE_WITH_BI_SUPPORT - CONNECTED_DEVICE - LISTING - TLS_ENCRYPTION - DOMAIN_LEVEL_SEND - EFAX_ROUTER - PRORATED_CREDIT - NEW_HIRE - NAS - SALESFORCE_USER - INTERVIEW - ASSESSMENT - NU_WEBEX_CALLING_ENHANCED - NU_WEBEX_CALLING_PROFESSIONAL - WEBEX_ASSISTANT_FOR_WEBEX_MEETINGS_NU - NU_MEETINGS_BRIDGE_COUNTRY_CALL_BACK_AUDIO - FLEX_TEAMS_MESSAGING - ADDON_ANALYSES - ADDITIONAL_LISTING - MIGRATION_TENANT - MIGRATION_GROUP - MIGRATION_DOCUMENT - MIGRATION_GSUITE - MIGRATION_FOLDER - ENHANCED_USER - SINGLE_NAME_CERTIFICATE - SETUP - HA_DEVICE_DAY - WILDCARD_CERTIFICATE - SECURITY_PACKAGE - ADDITIONAL_LANGUAGE - VANITY_URL - BRANDING - DATA_SOURCE - CREATOR_USER - ESIGN_USER - READ_ONLY_USER - MEASURING_POINT - ANDON_TV - TABLET - USER_10000 - USER_100 - PUBLIC_IP - WORKLOAD - PUBLIC_IP_ADDRESS - COMPUTE_POINT - RESOURCE_UNIT - VALUE_POINT - ACCOUNT - REQUEST - TRANSCRIPT - NOTIFICATION - CLAIM - MID - ENGAGEMENT - TEAM_LICENSE_DIGITAL_TEAMBOARD - TEAM_LICENSE_MODULE_CONNECTIVITY - TEAM_LICENSE_MODULE_PROBLEM_SOLUTION - TEAM_LICENSE_MODULE_AUDITS - TEAM_LICENSE_MODULE_PROCESS_CONFIRMATION - TEAM_LICENSE_MODULE_QUALIFICATION_MATRIX - TEAM_LICENSE_MODULE_STANDARD_WORK_INSTRUCTION - TEAM_LICENSE_MODULE_PARETO_ANALYSIS - KPI - YEAR_KPI_ARCHIVAL - CORPORATE_CLOUD_HOSTING - ON_PREMISES_HOSTING - SUPPORT_SERVICE_HOUR - CLASS - EXPERT - SPINDLE_HOUR - ADDON_ADMINISTRATION - ADDON_CONFIGURATION - ADDON_PLANNING - ADDON_PLANNING_OBJECTS - ADDON_MASTER_DATA - ADDON_CAPACITY_PLANS_CALENDAR - ADDON_CONFLICT_RADAR - ADDON_GAP_LIST - ADDON_DASHBOARD - ADDON_PLANNING_READ_ONLY - ADDON_UTILIZATION_POOLS - ADDON_FIXED_SCHEDULES - ADDON_ASSEMBLY_GROUPS - ADDON_ORDER_ON_HOLD - ADDON_PARALLEL_RESSOURCES - ADDON_MULTI_FUNCTIONAL_RESSOURCES - ADDON_PLANEUS_TV_PER_TERMINAL - ADDON_MASTER_DATA_WORK_PROCEDURES - ADDON_MANUAL_IMPORT - ADDON_AUTOMATIC_IMPORT - ADDON_REPORTING_BASIC - ADDON_REPORTING_ADVANCED - ADDON_REPORT_RESOURCES_AVAILABILITY_PER_DAY - ADDON_REPORT_OEE - ADDON_REPORT_ON_TIME_DELIVERY_HISTORY - ADDON_REPORT_PROCESS_PERFORMANCE_HISTORY - ADDON_REPORT_UTILIZATION_PER_RESOURCE - ADDON_REPORT_REPORTING_PLUG_IN - ADDON_EXTERNAL_PARTNERS_BASIC_LICENSE - ADDON_WORKBENCH_PACK_OF_5 - ADDON_WORKBENCH_PACK_OF_10 - ADDON_WORKBENCH_PACK_OF_15 - CLIENT - VIRTUAL_MACHINE - MODEL_TRANSFORMATION - CASE_REFRESH - CASE_VIEW - CASE_DOCUMENT_DOWNLOAD - VERIFICATION - ADDON_CORPORATE_BRANDING - CLIENT_TAX_FILINGS - CLIENT_COMPLIANCE_SERVICES - PROPOSAL - UK_ID_CHECK - INTERNATIONAL_ID_CHECK - CREDIT_SCREEN - UK_COMPANY_REPORT - NON_UK_COMPANY_REPORT - HR_SCREEN - COMPANY_FORMATION - CLIENT_ACCOUNTS - SMARTKIT - WORKFLOW - EDITOR - WORKER - ADDON_POTENTIAL_ANALYSIS - TRAINING_PACKAGE_SMALL - TRAINING_PACKAGE_LARGE - TOOL_PATH_OPTIMIZATION - CLIENT_VAT_FILINGS - BUNDLE - PACKAGE - VM - INCIDENT - SEND - INTEGRATION - BILLABLE_HOUR - TB - SOURCE - TRAINING - SITE - CONSULTING_UNIT - CAPACITY - MIGRATION - WORKSHOP - ONBOARDING - BENEFIT_ELIGIBLE_EMPLOYEE - SEAT - MS365_SEAT - MS_EXCHANGE_MAILBOX - GWORKSPACE_SEAT - INTERNET_LINE - BACKUP_LINE - USER_PACK_50 - USER_PACK_100 - CIRCUIT - NAC - INFRASTRUCTURE - TEN_THOUSAND_TEST_RUNS - ONE_THOUSAND_TEST_RUNS - INGESTED_OR_SCANNED_GB - MILLION_LOG_EVENTS - GB_OUTBOUND_PER_DESTINATION - DESTINATION - COMMITTER - INGESTED_GB - CPU - ONE_THOUSAND_SESSIONS - MILLION_RECORDS - GB_OF_ANALYZED_LOGS - ACTIVE_FUNCTION - MILLION_TRACED_INVOCATIONS - ACTIVE_APPLICATION_INSTANCES - HUNDRED_TEST_RUNS - ADDITIONAL_PARALLELIZATION - TASK - ONE_HUNDRED_WORKFLOW_EXECUTIONS - SCANNED_GB - USE_CASE - ONE_THOUSAND_ERROR_EVENTS - PERFORMANCE_GOAL - SCHOOL - MICROSOFT_365_TENANT - MARKETPLACE - LIEN_PROCESSED - DISBURSEMENT - A_LA_CARTE - SECURE - SECURE_PLUS - SECURE_EXTRA - PHASR - ENCRYPTION - EMAIL_SECURITY - MOBILE_SECURITY - EXCHANGE - ATS - EDR - EDR_RETENTION_90D - EDR_RETENTION_180D - EDR_RETENTION_1Y - INTEGRITY_MON - INTEGRITY_MON_RETENTION_90D - INTEGRITY_MON_RETENTION_180D - INTEGRITY_MON_RETENTION_1Y - MDR_FOUNDATIONS - PATCH_MANAGEMENT - VIRTUAL_ENV_VS - VIRTUAL_ENV_VDI - CONTAINER_PROTECTION - XDR_IDENTITY_SENSOR - XDR_PRODUCTIVITY_SENSOR - XDR_NETWORK_SENSOR - XDR_CLOUD_SENSOR - COMPLIANCE_MANAGER - EASM - SUPERVISOR - GB_OF_PROVISIONED_VM_RAM_PER_HOUR - GB_OF_USED_VM_STORAGE_PER_HOUR - GB_OF_USED_S3_STORAGE_PER_HOUR - VIRTUAL_ENVIRONMENT_VE_PER_MONTH - STORAGE_100_GB_PER_MONTH - GB_RAM_UNDER_MANAGEMENT_PER_MONTH - GB_OF_VM_RAM_PER_HOUR - BUSINESS_CLIENT - SELF_EMPLOYED_CLIENT - LANDLORD_CLIENT - DATA_HEALTH_AND_INSIGHT_ADDON - SWITCH_DAY - ACCESS_POINT_DAY - DATABASE - FUNCTION - APP_SERVICE - FIREWALL - EDR_SA_MDR_FOUNDATIONS - EDR_SA - FED_USF_CHARGE - SERVICE_FEE - SERVICE_FEE_AP - SERVICE_FEE_SWITCH - SERVICE_FEE_ROUTER - USER_LICENCE_DAY - DEVICE_DAY - VM_DAY - ROUTER_DAY - FSE - ON_SITE_SERVICE - BASIC - BASIC_PLUS - STANDARD - STANDARD_PLUS - ADVANCED - ADVANCED_PLUS - PREMIUM_PLUS - XXS - XS - SMALL - MEDIUM - LARGE - XL - XXL - XXXL - CUSTOM - ENHANCED - INCIDENT_RESPONSE_SERVICE - JIRA_CONNECTOR - SHAREPOINT_CONNECTOR - CONFLUENCE_CONNECTOR - PRIVATE_ACCESS - INTERNET_ACCESS - OBJECTIVE_FEEDBACK_QUESTION - STAFFBASE_CONNECTOR - CONSULTING_UNIT_AP - CONSULTING_UNIT_ROUTER - CONSULTING_UNIT_SWITCH - OBJECT - VALIDATION - ADVANCED_ELECTRONIC_SIGNATURE - QUALIFIED_ELECTRONIC_SIGNATURE - PERSONAL_IDENTIFICATION - API_BASED_SIGNATURE - ON_CALL_DUTY - VSBU - PAID_USER - REMOTE_SEAL_SIGNATURE SubscriptionProcessorTypeDto: type: string enum: - STRIPE - APPDIRECT - APPLE - TENANT InvoiceListingWS: allOf: - $ref: '#/components/schemas/ResourceSupport' - type: object title: InvoiceListing properties: company: $ref: '#/components/schemas/LinkWS' creationDate: description: Creation date for the invoice. type: number nullable: true orderIds: type: array description: Array of Order IDs items: type: string currency: $ref: '#/components/schemas/Currency' dueDate: description: Due date for the invoice. type: number nullable: true invoiceId: description: Invoice ID. type: number nullable: true referenceNumber: description: Reference number. type: string nullable: true status: $ref: '#/components/schemas/InvoiceStatus' total: description: Invoice total. type: number nullable: true user: $ref: '#/components/schemas/LinkWS' example: company: href: '...' id: '...' creationDate: 12345 currency: DKK dueDate: 12345 invoiceId: 12345 links: - href: '...' rel: '...' - href: '...' rel: '...' referenceNumber: '...' status: PAID total: 12345 user: href: '...' id: '...' PaymentWS: allOf: - $ref: '#/components/schemas/ResourceSupport' - type: object title: Payment properties: amount: description: Payment amount. type: number nullable: true company: $ref: '#/components/schemas/LinkWS' currency: $ref: '#/components/schemas/Currency' date: description: Payment date. type: number nullable: true gatewayResponse: $ref: '#/components/schemas/GatewayResponseWS' id: description: Payment number. type: number nullable: true method: $ref: '#/components/schemas/PaymentMethod' result: $ref: '#/components/schemas/PaymentResult' transactionId: description: Transaction ID. type: string nullable: true user: $ref: '#/components/schemas/LinkWS' example: amount: 12345 company: href: '...' id: '...' currency: INR date: 12345 gatewayResponse: avs: true code: '...' cvv: true message: '...' id: 12345 links: - href: '...' rel: '...' - href: '...' rel: '...' method: PAYPAL result: GATEWAY_NOT_AVAILABLE transactionId: '...' user: href: '...' id: '...' OrgSubscriptionPricingPlanDto: type: string enum: - FREE - FREE_MULTI_USER - PERSONAL - BUSINESS - ENTERPRISE OrgMembershipTypeDto: type: string enum: - FULL - RESTRICTED OrderWS: allOf: - $ref: '#/components/schemas/BaseOrderWS' - type: object title: Order properties: activated: description: True if the subscription has been activated type: boolean contract: $ref: '#/components/schemas/OrderContractWS' customAttributes: description: List of custom attributes associated with this order type: array items: $ref: '#/components/schemas/ChannelCustomAttributeWS' discount: $ref: '#/components/schemas/LinkWS' discountId: description: The unique identifier for the discount applied to this order type: number nullable: true nextOrder: $ref: '#/components/schemas/LinkWS' oneTimeOrders: description: List of one time orders associated with this subscription order type: array items: $ref: '#/components/schemas/OrderListingWS' orderLines: description: List of order lines for this subscription order type: array items: $ref: '#/components/schemas/OrderLineWS' parameters: description: List of custom parameters associated with this order type: array items: $ref: '#/components/schemas/ParameterWS' paymentPlan: $ref: '#/components/schemas/PaymentPlanWS' paymentPlanId: description: The unique identifier for the payment plan for this order type: number nullable: true previousOrder: $ref: '#/components/schemas/LinkWS' example: _embedded: property1: {} property2: {} activated: true company: href: '...' id: '...' contract: {} currency: '...' customAttributes: - attributeType: TEXT name: '...' value: '...' valueKeys: - '...' - '...' - attributeType: MULTISELECT name: '...' value: '...' valueKeys: - '...' - '...' discount: href: '...' id: '...' discountId: 12345 endDate: 12345 endOfDiscountDate: 12345 frequency: '...' id: 12345 links: - href: '...' rel: '...' - href: '...' rel: '...' nextBillingDate: 12345 nextOrder: href: '...' id: '...' oneTimeOrders: - _embedded: property1: {} property2: {} company: href: '...' id: '...' currency: '...' endDate: 12345 endOfDiscountDate: 12345 frequency: '...' id: 12345 links: - href: '...' rel: '...' - href: '...' rel: '...' nextBillingDate: 12345 paymentPlan: href: '...' id: '...' referenceCode: '...' salesSupportUser: href: '...' id: '...' startDate: 12345 status: '...' totalPrice: 12345 type: '...' user: href: '...' id: '...' - _embedded: property1: {} property2: {} company: href: '...' id: '...' currency: '...' endDate: 12345 endOfDiscountDate: 12345 frequency: '...' id: 12345 links: - href: '...' rel: '...' - href: '...' rel: '...' nextBillingDate: 12345 paymentPlan: href: '...' id: '...' referenceCode: '...' salesSupportUser: href: '...' id: '...' startDate: 12345 status: '...' totalPrice: 12345 type: '...' user: href: '...' id: '...' orderLines: - {} - {} parameters: - name: '...' value: '...' - name: '...' value: '...' paymentPlan: allowCustomUsage: true contract: alignWithParentCycleStartDate: true autoExtensionPricingId: 12345 blockContractDowngrades: true blockContractUpgrades: true blockSwitchToShorterContract: true cancellationPeriodLimit: 12345 endOfContractGracePeriod: 12345 gracePeriod: {} minimumServiceLength: 12345 terminationFee: {} cost: - amount: {} blockContractDecrease: true blockContractIncrease: true blockOriginalContractDecrease: true editionPricingItemId: 12345 id: 12345 increment: 12345 maxUnits: 12345 meteredUsage: true minUnits: 12345 pricePerIncrement: true pricingStrategy: '...' unit: '...' unitDependency: '...' - amount: {} blockContractDecrease: true blockContractIncrease: true blockOriginalContractDecrease: true editionPricingItemId: 12345 id: 12345 increment: 12345 maxUnits: 12345 meteredUsage: true minUnits: 12345 pricePerIncrement: true pricingStrategy: '...' unit: '...' unitDependency: '...' discount: amount: {} availableRedemptions: 12345 description: '...' expirationDate: 12345 numOfBillingCycles: 12345 percentage: 12345 pricingUnit: CALLING_FEATURE startDate: 12345 frequency: '...' href: '...' id: 12345 isPrimaryPrice: true keepBillDateOnUsageChange: true primaryPrice: true separatePrepaid: true tld: '...' uuid: '...' paymentPlanId: 12345 previousOrder: href: '...' id: '...' referenceCode: '...' salesSupportUser: href: '...' id: '...' startDate: 12345 status: '...' totalPrice: 12345 type: '...' user: href: '...' id: '...' nullable: true UsageLimitsDto: type: object required: - tokenLimits - dataUsageLimitInGb - mediaUsageTokenLimit properties: tokenLimits: type: object required: - standard - premium properties: standard: $ref: '#/components/schemas/TokenLimitsDto' nullable: true premium: $ref: '#/components/schemas/TokenLimitsDto' nullable: true dataUsageLimitInGb: type: number mediaUsageTokenLimit: type: integer PlanCostWS: description: Plan cost type: object title: PlanCost properties: amount: $ref: '#/components/schemas/PriceWS' blockContractDecrease: description: Block contract decrease type: boolean blockContractIncrease: description: Block contract increase type: boolean blockOriginalContractDecrease: description: Block original contract decrease type: boolean editionPricingItemId: type: number id: description: ID type: number increment: description: Increment amount type: number maxUnits: description: Max unit to buy type: number meteredUsage: description: Is metered usage type: boolean minUnits: description: Minimum unit to buy type: number pricePerIncrement: description: Price per increment type: boolean pricingStrategy: description: Pricing strategy type: string unit: description: Unit type: string nullable: true unitDependency: description: Unit dependency type: string example: amount: AUD: 12345 BRL: 12345 CAD: 12345 CHF: 12345 CNY: 12345 DKK: 12345 EUR: 12345 GBP: 12345 GTQ: 12345 INR: 12345 JPY: 12345 KRW: 12345 MXN: 12345 MYR: 12345 NOK: 12345 NZD: 12345 PHP: 12345 SAR: 12345 SEK: 12345 SGD: 12345 USD: 12345 ZAR: 12345 blockContractDecrease: true blockContractIncrease: true blockOriginalContractDecrease: true editionPricingItemId: 12345 id: 12345 increment: 12345 maxUnits: 12345 meteredUsage: true minUnits: 12345 pricePerIncrement: true pricingStrategy: '...' unit: '...' unitDependency: '...' OrderListingWS: allOf: - $ref: '#/components/schemas/BaseOrderWS' - type: object title: OrderListing properties: paymentPlan: $ref: '#/components/schemas/LinkWS' example: _embedded: property1: {} property2: {} company: href: '...' id: '...' currency: '...' endDate: 12345 endOfDiscountDate: 12345 frequency: '...' id: 12345 links: - href: '...' rel: '...' - href: '...' rel: '...' nextBillingDate: 12345 paymentPlan: href: '...' id: '...' referenceCode: '...' salesSupportUser: href: '...' id: '...' startDate: 12345 status: '...' totalPrice: 12345 type: '...' user: href: '...' id: '...' OrderUnitContractWS: type: object title: OrderUnitContractWS properties: unit: description: The unit type type: string nullable: true blockContractIncrease: description: Determines whether to block quantity increases for this unit type: boolean blockOriginalContractDecrease: description: Determines whether to block quantity decreases for this unit if the new quantity would be smaller than the quantity specified in the original contract type: boolean blockContractDecrease: description: Determines whether to block quantity decreases for this unit type: boolean example: unit: USER blockContractIncrease: true blockOriginalContractDecrease: false blockContractDecrease: false nullable: true PaymentMethod: type: string description: The supported payment methods title: PaymentMethod enum: - CREDIT_CARD - PAYPAL - MANUAL - EXTERNAL_INVOICE - MARKETPLACE_CREDITS InvoiceStatus: type: string title: InvoiceStatus enum: - PAID - UNPAID - CARRIED - VOIDED SubscriptionWS: type: object title: Subscription properties: assignedUsers: description: Number of users assigned to subscription type: number nullable: true bundleApplicationId: description: Bundle ID. Specify during subscription creation if you want the subscription to be part of a bundle. Retrieve a list of bundle IDs with the [List all bundles](#list-all-bundles) request, and then specify the desired ID here. Only supported for the [Create a subscription](#create-a-subscription) endpoint and not supported for any other endpoints. type: number nullable: true company: $ref: '#/components/schemas/LinkWS' creationDate: description: Subscription creation date type: number nullable: true edition: $ref: '#/components/schemas/LinkWS' endDate: description: Subscription end date type: number nullable: true externalAccountId: description: External account identifier (from vendor) type: string nullable: true id: description: ID type: string nullable: true internalId: description: The UUID for a subscription type: string nullable: true externalId: description: External ID for a subscription. Not used to change or create a subscription. If a subscription has an external ID, the ID is included in the responses to the [list subscription](#list-subscriptions) or [read subscription](#retrieve-a-subscription) APIs. To set an external ID of a subscription, use the [Update subscriptions](#update-subscriptions) API. type: string nullable: true label: description: Label for a subscription type: string nullable: true maxUsers: description: Maximum number of users allowed to be assigned to subscription type: number nullable: true order: $ref: '#/components/schemas/OrderWS' product: $ref: '#/components/schemas/LinkWS' redirectUrl: description: Interactive endpoint URL type: string nullable: true status: description: Subscription status (Valid values are INITIALIZED, FAILED, FREE_TRIAL, FREE_TRIAL_EXPIRED, ACTIVE, SUSPENDED, or CANCELLED.) type: string nullable: true upcomingOrder: $ref: '#/components/schemas/OrderWS' user: $ref: '#/components/schemas/LinkWS' example: assignedUsers: 12345 bundleApplicationId: 12345 company: href: '...' id: '...' creationDate: 12345 edition: href: '...' id: '...' endDate: 12345 externalAccountId: '...' id: '...' internalId: '...' maxUsers: 12345 order: _embedded: property1: {} property2: {} activated: true company: href: '...' id: '...' contract: minimumServiceLength: 24 endOfContractDate: 123451232 gracePeriodEndDate: null cancellationPeriodLimit: null endOfContractGracePeriod: null terminationFee: type: PERCENTAGE description: Fee percentage: 100 price: null estimatedCost: 324.56 renewal: null currency: '...' customAttributes: - attributeType: TEXT name: '...' value: '...' valueKeys: - '...' - '...' - attributeType: TEXT name: '...' value: '...' valueKeys: - '...' - '...' discount: href: '...' id: '...' discountId: 12345 endDate: 12345 endOfDiscountDate: 12345 frequency: '...' id: 12345 links: - href: '...' rel: '...' - href: '...' rel: '...' nextBillingDate: 12345 nextOrder: href: '...' id: '...' oneTimeOrders: - _embedded: property1: {} property2: {} company: {} currency: '...' endDate: 12345 endOfDiscountDate: 12345 frequency: '...' id: 12345 links: - {} - {} nextBillingDate: 12345 paymentPlan: {} referenceCode: '...' salesSupportUser: {} startDate: 12345 status: '...' totalPrice: 12345 type: '...' user: {} - _embedded: property1: {} property2: {} company: {} currency: '...' endDate: 12345 endOfDiscountDate: 12345 frequency: '...' id: 12345 links: - {} - {} nextBillingDate: 12345 paymentPlan: {} referenceCode: '...' salesSupportUser: {} startDate: 12345 status: '...' totalPrice: 12345 type: '...' user: {} orderLines: - {} - {} parameters: - name: '...' value: '...' - name: '...' value: '...' paymentPlan: allowCustomUsage: true contract: {} cost: - {} - {} discount: {} frequency: '...' href: '...' id: 12345 isPrimaryPrice: true keepBillDateOnUsageChange: true primaryPrice: true separatePrepaid: true tld: '...' uuid: '...' paymentPlanId: 12345 previousOrder: href: '...' id: '...' referenceCode: '...' salesSupportUser: href: '...' id: '...' startDate: 12345 status: '...' totalPrice: 12345 type: '...' user: href: '...' id: '...' product: href: '...' id: '...' redirectUrl: '...' status: '...' upcomingOrder: _embedded: property1: {} property2: {} activated: true company: href: '...' id: '...' contract: {} currency: '...' customAttributes: - attributeType: TEXT name: '...' value: '...' valueKeys: - '...' - '...' - attributeType: TEXT name: '...' value: '...' valueKeys: - '...' - '...' discount: href: '...' id: '...' discountId: 12345 endDate: 12345 endOfDiscountDate: 12345 frequency: '...' id: 12345 links: - href: '...' rel: '...' - href: '...' rel: '...' nextBillingDate: 12345 nextOrder: href: '...' id: '...' oneTimeOrders: - _embedded: property1: {} property2: {} company: {} currency: '...' endDate: 12345 endOfDiscountDate: 12345 frequency: '...' id: 12345 links: - {} - {} nextBillingDate: 12345 paymentPlan: {} referenceCode: '...' salesSupportUser: {} startDate: 12345 status: '...' totalPrice: 12345 type: '...' user: {} - _embedded: property1: {} property2: {} company: {} currency: '...' endDate: 12345 endOfDiscountDate: 12345 frequency: '...' id: 12345 links: - {} - {} nextBillingDate: 12345 paymentPlan: {} referenceCode: '...' salesSupportUser: {} startDate: 12345 status: '...' totalPrice: 12345 type: '...' user: {} orderLines: - {} - {} parameters: - name: '...' value: '...' - name: '...' value: '...' paymentPlan: allowCustomUsage: true contract: {} cost: - {} - {} discount: {} frequency: '...' href: '...' id: 12345 isPrimaryPrice: true keepBillDateOnUsageChange: true primaryPrice: true separatePrepaid: true tld: '...' uuid: '...' paymentPlanId: 12345 previousOrder: href: '...' id: '...' referenceCode: '...' salesSupportUser: href: '...' id: '...' startDate: 12345 status: '...' totalPrice: 12345 type: '...' user: href: '...' id: '...' user: href: '...' id: '...' nullable: true PaymentPlanWS: description: Payment plan for a product edition type: object title: PaymentPlan properties: allowCustomUsage: description: Custom usage allowed type: boolean contract: $ref: '#/components/schemas/ContractWS' cost: description: List of plan costs type: array items: $ref: '#/components/schemas/PlanCostWS' discount: $ref: '#/components/schemas/ProductDiscountDetailsWS' frequency: description: 'Billing frequency: MONTHLY, QUARTERLY, SIX_MONTHS, YEARLY, TWO_YEARS, THREE_YEARS, DAILY' type: string href: description: URL to payment plan details type: string id: description: ID type: number isPrimaryPrice: description: Is primary price type: boolean keepBillDateOnUsageChange: description: Keep bill date on usage change type: boolean separatePrepaid: description: Separate prepaid type: boolean tld: description: If plan is part of a domain reseller product, this is the tld this plan offers type: string uuid: description: Unique identifier type: string nullable: true example: allowCustomUsage: true contract: alignWithParentCycleStartDate: true autoExtensionPricingId: 12345 blockContractDowngrades: true blockContractUpgrades: true blockSwitchToShorterContract: true cancellationPeriodLimit: 12345 endOfContractGracePeriod: 12345 gracePeriod: length: 12345 unit: '...' minimumServiceLength: 12345 terminationFee: description: '...' flatFee: {} percentageFee: 12345 type: '...' cost: - amount: AUD: 12345 BRL: 12345 CAD: 12345 CHF: 12345 CNY: 12345 DKK: 12345 EUR: 12345 GBP: 12345 GTQ: 12345 INR: 12345 JPY: 12345 KRW: 12345 MXN: 12345 MYR: 12345 NOK: 12345 NZD: 12345 PHP: 12345 SAR: 12345 SEK: 12345 SGD: 12345 USD: 12345 ZAR: 12345 blockContractDecrease: true blockContractIncrease: true blockOriginalContractDecrease: true editionPricingItemId: 12345 id: 12345 increment: 12345 maxUnits: 12345 meteredUsage: true minUnits: 12345 pricePerIncrement: true pricingStrategy: '...' unit: '...' unitDependency: '...' - amount: AUD: 12345 BRL: 12345 CAD: 12345 CHF: 12345 CNY: 12345 DKK: 12345 EUR: 12345 GBP: 12345 GTQ: 12345 INR: 12345 JPY: 12345 KRW: 12345 MXN: 12345 MYR: 12345 NOK: 12345 NZD: 12345 PHP: 12345 SAR: 12345 SEK: 12345 SGD: 12345 USD: 12345 ZAR: 12345 blockContractDecrease: true blockContractIncrease: true blockOriginalContractDecrease: true editionPricingItemId: 12345 id: 12345 increment: 12345 maxUnits: 12345 meteredUsage: true minUnits: 12345 pricePerIncrement: true pricingStrategy: '...' unit: '...' unitDependency: '...' discount: amount: AUD: 12345 BRL: 12345 CAD: 12345 CHF: 12345 CNY: 12345 DKK: 12345 EUR: 12345 GBP: 12345 GTQ: 12345 INR: 12345 JPY: 12345 KRW: 12345 MXN: 12345 MYR: 12345 NOK: 12345 NZD: 12345 PHP: 12345 SAR: 12345 SEK: 12345 SGD: 12345 USD: 12345 ZAR: 12345 availableRedemptions: 12345 description: '...' expirationDate: 12345 numOfBillingCycles: 12345 percentage: 12345 pricingUnit: INTERNATIONAL_MINUTE startDate: 12345 frequency: '...' href: '...' id: 12345 isPrimaryPrice: true keepBillDateOnUsageChange: true separatePrepaid: true tld: '...' uuid: '...' OrgSubscriptionDto: type: object required: - uuid - orgId - createdAt - updatedAt - type - pricingPlan - pricingPlanLabel - maxUsers - allowsMultipleUsers - maxFreeUsers - allowsFreeUsers - userMembershipType - status - periodEndDate - usageLimits - externalSubscriptionId - externalCustomerId - processorType - metadata - cancelledAt - periodStartDate - balanceAllocationPerUser - storageAllocationGb - enforceBillingSinceCycleStart properties: uuid: type: string description: Public identifier for the organization subscription. orgId: type: string description: Organization ID associated with the subscription. createdAt: type: string format: date-time description: The date and time when the subscription was created. updatedAt: type: string format: date-time description: The date and time when the subscription was last updated. type: $ref: '#/components/schemas/OrgSubscriptionTypeDto' pricingPlan: $ref: '#/components/schemas/OrgSubscriptionPricingPlanDto' pricingPlanLabel: type: string description: Human-readable pricing plan label. maxUsers: type: integer nullable: true description: Maximum number of users allowed by the subscription. allowsMultipleUsers: type: boolean description: Whether the subscription permits multiple users. maxFreeUsers: type: integer nullable: true description: Maximum number of free users allowed by the subscription. allowsFreeUsers: type: boolean description: Whether the subscription permits restricted/free users. userMembershipType: $ref: '#/components/schemas/OrgMembershipTypeDto' status: $ref: '#/components/schemas/OrgSubscriptionStatusDto' periodEndDate: type: string format: date-time nullable: true description: The current subscription period end date, when available. usageLimits: nullable: true allOf: - $ref: '#/components/schemas/UsageLimitsDto' externalSubscriptionId: type: string nullable: true description: External processor subscription identifier. externalCustomerId: type: string nullable: true description: External processor customer identifier. processorType: nullable: true allOf: - $ref: '#/components/schemas/SubscriptionProcessorTypeDto' metadata: $ref: '#/components/schemas/SubscriptionMetadataDto' cancelledAt: type: string format: date-time nullable: true description: ISO-8601 cancel signal. Set on cancellation while status may remain ACTIVE until the subscription period closes. periodStartDate: type: string format: date-time nullable: true description: Current subscription period start date, when available. balanceAllocationPerUser: type: string nullable: true description: Dollar allocation per user as a decimal string (preserves precision). storageAllocationGb: type: integer nullable: true description: Storage allocation in gigabytes for the subscription plan. enforceBillingSinceCycleStart: type: string format: date-time nullable: true description: Cycle start when dollar-balance enforcement began, or null when deferred. Link: type: object title: Link properties: href: type: string rel: type: string example: href: '...' rel: '...' nullable: true DurationWS: description: Contract duration type: object title: Duration properties: length: description: Length type: number unit: description: Duration unit type: string nullable: true example: length: 12345 unit: '...' nullable: true SubscriptionUpdateWS: type: object title: SubscriptionUpdate required: - status properties: status: type: string description: The desired subscription lifecycle status. Set to SUSPENDED to suspend an active subscription, or ACTIVE to reactivate a suspended subscription. enum: - ACTIVE - SUSPENDED suspensionReasonMessage: type: string description: Reason for subscription suspension. Only used, and required, when setting the status to SUSPENDED. externalId: type: string description: The external ID to add or update in the subscription. Only set an external ID if required. customAttributes: type: array description: An array of subscription custom attributes. If specified in a PATCH request, the values will be updated or added to the subscription. The custom attributes must already be defined in the marketplace (at Manage > Marketplace > Settings > Custom Attributes > Subscription Custom Attributes). items: $ref: '#/components/schemas/SubscriptionCustomAttributeWS' example: status: SUSPENDED suspensionReasonMessage: The customer is undergoing an internal investigation. All subscriptions are suspended. customAttributes: - name: test1 values: - value1 - name: test2 values: - value2 - value3 nullable: true CompanyEntitlementSuspensionReason: type: string title: CompanyEntitlementSuspensionReason enum: - PAYMENT_OVERDUE - END_OF_CONTRACT - UNSUCCESSFUL_PAYMENT - MANUALLY_SUSPENDED - API - PARENT_SUBSCRIPTION_SUSPENDED AddonInstanceWS: type: object title: AddonInstance properties: creationDate: description: Creation date of the addon instance type: number nullable: true offeringUuid: description: Unique identifier for add-on offering type: string nullable: true order: $ref: '#/components/schemas/OrderWS' status: description: Addon instance status. May be ACTIVE, CANCELLED or FAILED. type: string nullable: true units: description: Units for add-on instance type: number nullable: true uuid: description: Unique identifier for add-on instance type: string nullable: true example: creationDate: 12345 offeringUuid: '...' order: _embedded: property1: {} property2: {} activated: true company: href: '...' id: '...' contract: {} currency: '...' customAttribute: - attributeType: MULTISELECT name: '...' value: '...' valueKeys: - '...' - '...' - attributeType: MULTISELECT name: '...' value: '...' valueKeys: - '...' - '...' discount: href: '...' id: '...' discountId: 12345 endDate: 12345 endOfDiscountDate: 12345 frequency: '...' id: 12345 links: - href: '...' rel: '...' - href: '...' rel: '...' nextBillingDate: 12345 nextOrder: href: '...' id: '...' oneTimeOrder: - _embedded: property1: {} property2: {} company: {} currency: '...' endDate: 12345 endOfDiscountDate: 12345 frequency: '...' id: 12345 links: - {} - {} nextBillingDate: 12345 paymentPlan: {} referenceCode: '...' salesSupportUser: {} startDate: 12345 status: '...' totalPrice: 12345 type: '...' user: {} - _embedded: property1: {} property2: {} company: {} currency: '...' endDate: 12345 endOfDiscountDate: 12345 frequency: '...' id: 12345 links: - {} - {} nextBillingDate: 12345 paymentPlan: {} referenceCode: '...' salesSupportUser: {} startDate: 12345 status: '...' totalPrice: 12345 type: '...' user: {} orderLine: - {} - {} parameter: - name: '...' value: '...' - name: '...' value: '...' paymentPlan: allowCustomUsage: true contract: {} cost: - {} - {} discount: {} frequency: '...' href: '...' id: 12345 isPrimaryPrice: true keepBillDateOnUsageChange: true primaryPrice: true separatePrepaid: true tld: '...' uuid: '...' paymentPlanId: 12345 previousOrder: href: '...' id: '...' referenceCode: '...' salesSupportUser: href: '...' id: '...' startDate: 12345 status: '...' totalPrice: 12345 type: '...' user: href: '...' id: '...' status: '...' units: 12345 uuid: '...' nullable: true SubscriptionListingWS: allOf: - $ref: '#/components/schemas/HalResourceSupport' - type: object title: SubscriptionListing properties: assignmentCount: description: Current number of users assigned. type: number nullable: true bundleApplicationId: description: Bundle ID. Specify during subscription creation if you want the subscription to be part of a bundle. Retrieve a list of bundle IDs with the [List all bundles](#list-all-bundles) request, and then specify the desired ID here. Only supported for the [Create a subscription](#create-a-subscription) endpoint and not supported for any other endpoints. type: number nullable: true company: $ref: '#/components/schemas/LinkWS' creationDate: description: Creation date for the subscription. type: number nullable: true edition: $ref: '#/components/schemas/LinkWS' endDate: description: End date for the subscription. type: number nullable: true externalAccountId: description: External account ID. type: string nullable: true id: description: Subscription listing ID. type: string nullable: true maxUsers: description: Maximum number of users allowed. type: number nullable: true order: $ref: '#/components/schemas/LinkWS' parentSubscriptionId: description: Parent subscription ID. (Applies to add-on products.) type: number nullable: true product: $ref: '#/components/schemas/LinkWS' status: $ref: '#/components/schemas/CompanyEntitlementStatus' suspensionReason: $ref: '#/components/schemas/CompanyEntitlementSuspensionReason' user: $ref: '#/components/schemas/LinkWS' example: _embedded: property1: {} property2: {} assignmentCount: 12345 bundleApplicationId: 12345 company: href: '...' id: '...' creationDate: 12345 edition: href: '...' id: '...' endDate: 12345 externalAccountId: '...' id: '...' links: - href: '...' rel: '...' - href: '...' rel: '...' maxUsers: 12345 order: href: '...' id: '...' parentSubscriptionId: 12345 product: href: '...' id: '...' status: FREE_TRIAL suspensionReason: END_OF_CONTRACT user: href: '...' id: '...' nullable: true SubscriptionCustomAttributeWS: type: object title: SubscriptionCustomAttribute description: A subscription custom attribute, as defined in the marketplace at Manage > Marketplace > Settings > Custom Attributes > Subscription Custom Attributes properties: name: type: string description: The key name of an existing subscription custom attribute values: description: Values of the custom attributes. If the attribute definition is MULTISELECT, all values must be a subset of the value options defined in the marketplace. If the attribute definition is TEXT, only one value is allowed. type: array items: type: string example: name: test1 values: - value1 - value2 TerminationFeeWS: description: Fee incurred during a termination of a product subscription type: object title: TerminationFee properties: description: description: Description type: string nullable: true flatFee: $ref: '#/components/schemas/PriceWS' percentageFee: description: Percentage fee type: number type: description: 'Type of termination fee: NONE, PERCENTAGE, FLAT_RATE' type: string example: description: '...' flatFee: AUD: 12345 BRL: 12345 CAD: 12345 CHF: 12345 CNY: 12345 DKK: 12345 EUR: 12345 GBP: 12345 GTQ: 12345 INR: 12345 JPY: 12345 KRW: 12345 MXN: 12345 MYR: 12345 NOK: 12345 NZD: 12345 PHP: 12345 SAR: 12345 SEK: 12345 SGD: 12345 USD: 12345 ZAR: 12345 percentageFee: 12345 type: '...' nullable: true OrderLineWS: type: object title: OrderLine properties: id: description: Order line ID type: number nullable: true editionPricingItemId: description: Edition pricing item ID type: number nullable: true type: description: Order line type, which can be ITEM, TAX, PENALTY, or DISCOUNT type: string nullable: true unit: description: Pricing unit for the order line item, such as USER, GIGABYTE, HOUR, and so on depending on product configuration type: string nullable: true quantity: description: Quantity for the order line item type: number nullable: true basePrice: description: Base price for the order line item type: number nullable: true price: description: The price for the order line item type: number nullable: true listingPrice: description: The listing price for the order line item type: number nullable: true percentage: description: The percentage associated with the order line item price. It can be a positive value (for example, for tax) or negative (for discounts). type: number nullable: true totalPrice: description: The total price for the order line item type: number nullable: true channelMarkupPrice: description: The marketplace sale price for the order line item type: number nullable: true resellerMarkupPrice: description: The reseller markup price for the order line item type: number nullable: true wholesalePrice: description: The wholesale price for the order line item type: number nullable: true applicationName: description: The order line application name type: number nullable: true editionName: description: The order line edition name type: string nullable: true editionDescription: description: The order line description type: string nullable: true example: description: Test App 1 - null - Per User Fee id: 3 editionPricingId: 1 editionName: Edition 1 listingPrice: 10 price: 10 quantity: 1 totalPrice: 10 type: ITEM unit: USER CompanyEntitlementStatus: type: string title: CompanyEntitlementStatus enum: - INITIALIZED - FAILED - FREE_TRIAL - FREE_TRIAL_EXPIRED - ACTIVE - SUSPENDED - CANCELLED nullable: true ParameterWS: type: object title: Parameter properties: name: type: string nullable: true value: type: string nullable: true example: name: '...' value: '...' LinkWS: type: object title: LinkWS properties: href: type: string id: type: string example: href: '...' id: '...' nullable: true HalResourceSupport: allOf: - $ref: '#/components/schemas/ResourceSupport' - type: object title: HalResourceSupport properties: _embedded: type: object additionalProperties: type: object nullable: true nullable: true example: _embedded: property1: {} property2: {} links: - href: '...' rel: '...' - href: '...' rel: '...' nullable: true ChannelCustomAttributeWS: type: object title: CustomAttribute properties: attributeType: $ref: '#/components/schemas/AttributeType' name: type: string nullable: true value: type: string nullable: true valueKeys: type: array items: type: string example: attributeType: MULTISELECT name: '...' value: '...' valueKeys: - '...' - '...' OrderTerminationFeeWS: type: object title: OrderTerminationFeeWS properties: type: description: Termination fee type, which can be NONE, PERCENTAGE, or FLAT_RATE type: string description: description: Termination fee description type: string percentage: description: Percentage to charge for the termination fee type: number nullable: true price: description: Flat rate price to charge for the termination fee type: number nullable: true estimatedCost: description: Estimated termination fee if the order were canceled immediately. Only populated with the Preview Cancel and Cancel operations. type: number nullable: true gracePeriod: description: Grace period for the termination fee type: number nullable: true gracePeriodUnit: description: Unit (days or months) of the grace period (if any) for the termination fee type: string nullable: true example: type: FLAT_RATE description: Flat rate fee percentage: null price: 5 estimatedCost: null gracePeriod: 5 gracePeriodUnit: DAYS nullable: true OrderDetailedListingWS: type: object title: OrderDetailedListing properties: order: description: List of orders. type: array items: $ref: '#/components/schemas/OrderWS' total: type: number nullable: true example: orders: - _embedded: property1: {} property2: {} activated: true company: href: '...' id: '...' contract: {} currency: '...' customAttribute: - attributeType: MULTISELECT name: '...' value: '...' valueKeys: - '...' - '...' - attributeType: MULTISELECT name: '...' value: '...' valueKeys: - '...' - '...' discount: href: '...' id: '...' discountId: 12345 endDate: 12345 endOfDiscountDate: 12345 frequency: '...' id: 12345 links: - href: '...' rel: '...' - href: '...' rel: '...' nextBillingDate: 12345 nextOrder: href: '...' id: '...' oneTimeOrder: - _embedded: property1: {} property2: {} company: {} currency: '...' endDate: 12345 endOfDiscountDate: 12345 frequency: '...' id: 12345 links: - {} - {} nextBillingDate: 12345 paymentPlan: {} referenceCode: '...' salesSupportUser: {} startDate: 12345 status: '...' totalPrice: 12345 type: '...' user: {} - _embedded: property1: {} property2: {} company: {} currency: '...' endDate: 12345 endOfDiscountDate: 12345 frequency: '...' id: 12345 links: - {} - {} nextBillingDate: 12345 paymentPlan: {} referenceCode: '...' salesSupportUser: {} startDate: 12345 status: '...' totalPrice: 12345 type: '...' user: {} orderLine: - {} - {} parameter: - name: '...' value: '...' - name: '...' value: '...' paymentPlan: allowCustomUsage: true contract: {} cost: - {} - {} discount: {} frequency: '...' href: '...' id: 12345 isPrimaryPrice: true keepBillDateOnUsageChange: true primaryPrice: true separatePrepaid: true tld: '...' uuid: '...' paymentPlanId: 12345 previousOrder: href: '...' id: '...' referenceCode: '...' salesSupportUser: href: '...' id: '...' startDate: 12345 status: '...' totalPrice: 12345 type: '...' user: href: '...' id: '...' - _embedded: property1: {} property2: {} activated: true company: href: '...' id: '...' contract: {} currency: '...' customAttribute: - attributeType: MULTISELECT name: '...' value: '...' valueKeys: - '...' - '...' - attributeType: TEXT name: '...' value: '...' valueKeys: - '...' - '...' discount: href: '...' id: '...' discountId: 12345 endDate: 12345 endOfDiscountDate: 12345 frequency: '...' id: 12345 links: - href: '...' rel: '...' - href: '...' rel: '...' nextBillingDate: 12345 nextOrder: href: '...' id: '...' oneTimeOrder: - _embedded: property1: {} property2: {} company: {} currency: '...' endDate: 12345 endOfDiscountDate: 12345 frequency: '...' id: 12345 links: - {} - {} nextBillingDate: 12345 paymentPlan: {} referenceCode: '...' salesSupportUser: {} startDate: 12345 status: '...' totalPrice: 12345 type: '...' user: {} - _embedded: property1: {} property2: {} company: {} currency: '...' endDate: 12345 endOfDiscountDate: 12345 frequency: '...' id: 12345 links: - {} - {} nextBillingDate: 12345 paymentPlan: {} referenceCode: '...' salesSupportUser: {} startDate: 12345 status: '...' totalPrice: 12345 type: '...' user: {} orderLine: - {} - {} parameter: - name: '...' value: '...' - name: '...' value: '...' paymentPlan: allowCustomUsage: true contract: {} cost: - {} - {} discount: {} frequency: '...' href: '...' id: 12345 isPrimaryPrice: true keepBillDateOnUsageChange: true primaryPrice: true separatePrepaid: true tld: '...' uuid: '...' paymentPlanId: 12345 previousOrder: href: '...' id: '...' referenceCode: '...' salesSupportUser: href: '...' id: '...' startDate: 12345 status: '...' totalPrice: 12345 type: '...' user: href: '...' id: '...' total: 12345 nullable: true BaseOrderWS: allOf: - $ref: '#/components/schemas/HalResourceSupport' - type: object title: BaseOrder properties: company: $ref: '#/components/schemas/LinkWS' currency: description: Currency. type: string nullable: true endDate: description: Order end date. type: number nullable: true endOfDiscountDate: description: Discount end date. type: number nullable: true frequency: description: Frequency. type: string nullable: true id: description: ID. type: number nullable: true parentSubscriptionId: description: Parent subscription ID of an add-on subscription type: number nullable: true serviceStartDate: description: Service start date for the order type: number nullable: true nextBillingDate: description: Next billing date for the order type: number nullable: true referenceCode: description: Reference code type: string nullable: true salesSupportUser: $ref: '#/components/schemas/LinkWS' salesSupportCompany: $ref: '#/components/schemas/LinkWS' startDate: description: Order start date type: number nullable: true status: description: Order status type: string nullable: true totalPrice: description: Total price for the order type: number nullable: true type: description: Type. type: string nullable: true user: $ref: '#/components/schemas/LinkWS' example: _embedded: property1: {} property2: {} company: href: '...' id: '...' currency: '...' endDate: 12345 endOfDiscountDate: 12345 frequency: '...' id: 12345 parentSubscriptionId: 12345 links: - href: '...' rel: '...' - href: '...' rel: '...' serviceStartDate: 12345 nextBillingDate: 12345 referenceCode: '...' salesSupportUser: href: '...' id: '...' salesSupportCompany: href: '...' id: '...' startDate: 12345 status: '...' totalPrice: 12345 type: '...' user: href: '...' id: '...' PaymentResult: type: string title: PaymentResult enum: - SUCCESSFUL - FAILED - GATEWAY_NOT_AVAILABLE - MANUAL PriceWS: description: Price information in different currencies type: object title: Price properties: AUD: type: number BRL: type: number CAD: type: number CHF: type: number CNY: type: number DKK: type: number EUR: type: number GBP: type: number GTQ: type: number INR: type: number JPY: type: number KRW: type: number MXN: type: number MYR: type: number NOK: type: number NZD: type: number PHP: type: number SAR: type: number SEK: type: number SGD: type: number USD: type: number ZAR: type: number example: AUD: 12345 BRL: 12345 CAD: 12345 CHF: 12345 CNY: 12345 DKK: 12345 EUR: 12345 GBP: 12345 GTQ: 12345 INR: 12345 JPY: 12345 KRW: 12345 MXN: 12345 MYR: 12345 NOK: 12345 NZD: 12345 PHP: 12345 SAR: 12345 SEK: 12345 SGD: 12345 USD: 12345 ZAR: 12345 nullable: true Currency: description: Supported currencies for the system type: string title: Currency enum: - USD - CAD - EUR - JPY - GBP - KRW - CHF - SEK - SGD - MYR - AUD - MXN - INR - BRL - DKK - NZD - NOK - ZAR - PHP - CNY - SAR - GTQ - IDR - ARS - COP - PEN default: USD GatewayResponseWS: type: object title: GatewayResponse properties: avs: description: True if address is validated. type: boolean code: description: Code. type: string nullable: true cvv: description: True if credit card is validated. type: boolean message: description: Message. type: string nullable: true example: avs: true code: '...' cvv: true message: '...' ContractWS: description: Contract associated to a payment plan type: object title: Contract properties: alignWithParentCycleStartDate: description: Is addon cycle start date contract aligned with parent cycle start date type: boolean autoExtensionPricingId: description: Auto extension pricing ID type: number nullable: true blockContractDowngrades: description: Is contract downgrade allowed type: boolean blockContractUpgrades: description: Is contract upgrade allowed type: boolean blockSwitchToShorterContract: description: Is switch to shorter contract allowed type: boolean cancellationPeriodLimit: description: Cancellation period limit type: number nullable: true endOfContractGracePeriod: description: End of contract grace period type: number nullable: true gracePeriod: $ref: '#/components/schemas/DurationWS' minimumServiceLength: description: Minimum service length type: number nullable: true terminationFee: $ref: '#/components/schemas/TerminationFeeWS' example: alignWithParentCycleStartDate: true autoExtensionPricingId: 12345 blockContractDowngrades: true blockContractUpgrades: true blockSwitchToShorterContract: true cancellationPeriodLimit: 12345 endOfContractGracePeriod: 12345 gracePeriod: length: 12345 unit: '...' minimumServiceLength: 12345 terminationFee: description: '...' flatFee: AUD: 12345 BRL: 12345 CAD: 12345 CHF: 12345 CNY: 12345 DKK: 12345 EUR: 12345 GBP: 12345 GTQ: 12345 INR: 12345 JPY: 12345 KRW: 12345 MXN: 12345 MYR: 12345 NOK: 12345 NZD: 12345 PHP: 12345 SAR: 12345 SEK: 12345 SGD: 12345 USD: 12345 ZAR: 12345 percentageFee: 12345 type: '...' TokenLimitsDto: type: object required: - input - output properties: input: type: integer output: type: integer ResourceSupport: type: object title: ResourceSupport description: Resource links properties: links: type: array description: Resource links items: $ref: '#/components/schemas/Link' example: links: - href: '...' rel: '...' - href: '...' rel: '...' nullable: true OrgSubscriptionTypeDto: type: string enum: - FREE - PAID