Answer5

AppResellerAccount6

AppResellerAssignment3

AppResellerCatalog2

AppResellerCompanyAssociation3

AppResellerLeads11

AppResellerOpportunities23

AppResellerOrder1

AppResellerPaymentMethod3

AppResellerQuoteVersion4

AppResellerReconciliation3

AppResellerSubscription5

Bundle3

checkoutItemDetails1

Comment5

Companies7

CompanyMemberships15

CurrencyExchangeRate4

CustomerNotification9

DataUploader3

DefaultNotificationTemplateApi5

Discount5

Domains3

Edition1

Event2

Group10

InboundEvents1

Integration4

Invitation5

Invoice7

Marketplace Product Settings5

MyApps4

Navigation1

Payment5

Payment Methods7

PaymentInstrument6

PaymentPlan3

Payments v29

Product8

Product Management API4

ProductContext2

PurchaseOrder7

Question4

Reconciliation1

Reporting3

Reporting V22

Review5

Search1

SegmentFolders15

Settings2

ShoppingCart28

SubscriptionAssignments5

Subscriptions23

Sync5

User13

UserAccounts2

AppResellerSubscription

Update subscription

Changed on Nov 6, 2026

Note: This endpoint is being deprecated. // Upgrade or downgrade a subscription on behalf of a user who is a member of a marketplace company linked to the current reseller company.<br/>When you upgrade or downgrade subscriptions, you must provide both the paymentPlanId and the orderLines objects in the request even if the units are not changing.

put/appReseller/v1/subscriptions/{subscriptionId}

Request

Base URL
https://marketplace.appdirect.com/api
Auth
none declared
TypeScript
https://skmtc.dev/appdirect/apis/companies/docs/appReseller/v1/subscriptions/:subscriptionId/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

subscriptionIdstring required

Subscription ID

Request body

paymentPlanIdstring

Edition Payment Plan ID

Example request

{
  "paymentPlanId": "30ccf1e7-1937-40cb-8e73-851a226fd4ea",
  "orderLines": [
    {
      "unit": "USER",
      "quantity": "15"
    }
  ]
}

Response

Success

idstring required

Subscription ID

createdOnnumber required

Creation date of the subscription, in Unix timestamp format

applicationNamestring required

Name of the application related to the subscription

statusstring required

Subscription status (valid values are INITIALIZED, FAILED, FREE_TRIAL, FREE_TRIAL_EXPIRED, ACTIVE, SUSPENDED, or CANCELLED)

referenceCodestring

Code provided by Resellers and Sales Agents while purchasing a subscription

Example response

{
  "id": "386626c0-53e2-4515-8450-4a720bb5d029",
  "createdOn": 1529083173000,
  "activeOrder": {
    "id": "1553",
    "paymentPlanId": "30ccf1e7-1937-40cb-8e73-851a226fd4ea",
    "orderLines": [
      {
        "unit": "USER",
        "quantity": "1"
      }
    ],
    "status": "PENDING MANUAL RECOVERY",
    "frequency": "One Time",
    "totalFee": "USD350.00",
    "editionName": "Edition",
    "createdOn": 1529083173000
  },
  "company": {
    "id": "698555fc-bc65-4163-9fee-16308edec41b",
    "name": "Company A"
  },
  "user": {
    "id": "2c061df6-4313-45e0-8709-a0ca19b0aaa3",
    "firstName": "Michael",
    "lastName": "Jordan"
  },
  "applicationName": "AUTO_DISCOUNTS_APP",
  "pendingEvent": "SUBSCRIPTION_CHANGE",
  "status": "ACTIVE",
  "referenceCode": "bundle09"
}

Changes

Nov 6, 20261fc240f06971 Revision changes
- breaking
  the request's body type changed from no type to object
- breaking
  the response's body type changed from no type to object for status
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status

Operation history