Получить и усилить; обновить подписку

После получения подписки вы можете использовать информацию из успешного ответа, чтобы изменить статус подписки или обновить подписку. На этой странице описаны различные способы получения и обновления подписки.

Получить подписку

Чтобы получить успешно заказанную или переданную подписку, используйте следующий HTTP-запрос GET .

GET https://reseller.googleapis.com/apps/reseller/v1/customers/CUSTOMER_ID/subscriptions/SUBSCRIPTION_ID

Замените следующее:

  • CUSTOMER_ID : либо основное доменное имя клиента, либо уникальный идентификатор клиента.
  • SUBSCRIPTION_ID : идентификатор подписки, уникальный для каждого клиента. Это значение можно получить с помощью метода Получить все подписки реселлера .

Эта операция не имеет параметров в теле запроса.

Успешный ответ возвращает код состояния HTTP 200 и настройки подписки. В следующем примере ответа свойство isInTrial имеет значение false , но свойство trialEndTime отсутствует, что означает, что этот клиент никогда не пользовался 30-дневной бесплатной пробной версией этого плана.

{
  "kind": "reseller#subscription",
  "customerId": "C0123456",
  "subscriptionId": "123",
  "skuId": "1010020028",
  "billingMethod": "ONLINE",
  "creationTime": "1331647980142",
  "plan": {
    "planName": "ANNUAL",
    "isCommitmentPlan": true,
    "commitmentInterval": {
      "startTime": "1331647980142",
      "endTime": "1363183980142"
    }
  },
  "seats": {
    "kind": "subscriptions#seats",
    "numberOfSeats": 10,
    "licensedNumberOfSeats": 10
  },
  "trialSettings": {
    "isInTrial": false
  },
  "renewalSettings": {
    "kind": "subscriptions#renewalSettings",
    "renewalType": "RENEW_CURRENT_USERS_MONTHLY_PAY"
  },
  "purchaseOrderId": "example.com_annual_1",
  "status": "ACTIVE",
  "resourceUiUrl": "URL to customer's Subscriptions page in the Admin console",
  "skuName": "Google Workspace Business Standard"
}

Получение всех подписок клиента

Чтобы получить все подписки конкретного клиента-посредника, которые были успешно заказаны или переданы, используйте следующий HTTP-запрос GET и включите токен авторизации:

GET https://reseller.googleapis.com/apps/reseller/v1/subscriptions?customerId=CUSTOMER_ID value&pageToken=START_DATE&maxResults=MAX_NUMBER

Замените следующее:

  • CUSTOMER_ID : либо основное доменное имя клиента, либо уникальный идентификатор клиента.
  • START_DATE : дата начала в формате YYYY-MM-DD .
  • MAX_NUMBER : максимальное количество результатов, возвращаемых на странице ответа.

Эта операция не имеет параметров в теле запроса.

В случае успешного ответа возвращается код состояния HTTP 200 и список подписок и настроек клиента. Список подписок может включать продукты, которые не управляются в этой версии API реселлера.

Если вы не управляете этим клиентом, то возвращается ошибка 403 "Forbidden" .

Получение всех передаваемых подписок для клиента

Чтобы получить все подписки клиента, которые потенциально могут быть переданы под управление реселлера, используйте следующий HTTP-запрос GET и включите токен авторизации. customerId является обязательным и представляет собой уникальный идентификатор клиента, возвращаемый при получении учетной записи перепроданного клиента . customerAuthToken — это токен передачи, предоставленный вашим клиентом и соответствующий вашему идентификатору реселлера. После создания клиентом он действителен в течение 30 дней. Дополнительную информацию о том, как клиенты генерируют токен, см. в разделе Перенос аккаунта Google Workspace реселлеру .

GET https://reseller.googleapis.com/apps/reseller/v1/subscriptions?customerId=CUSTOMER_ID&customerAuthToken=AUTH_TOKEN&pageToken=START_DATE&maxResults=MAX_NUMBER

Замените следующее:

  • CUSTOMER_ID : либо основное доменное имя клиента, либо уникальный идентификатор клиента.
  • AUTH_TOKEN : токен передачи, предоставленный вашим клиентом и соответствующий вашему идентификатору реселлера. После того, как он создан клиентом, он действителен в течение 30 дней. Дополнительную информацию о том, как клиенты генерируют токен, см. в разделе Перенос аккаунта Google Workspace реселлеру . Если это значение недействительно или срок его действия истек, ответ API возвращает ошибку 403 "Forbidden" .
  • START_DATE : дата начала в формате YYYY-MM-DD .
  • MAX_NUMBER : максимальное количество результатов, возвращаемых на странице ответа.

Эта операция не имеет параметров в теле запроса.

В случае успешного ответа возвращается код состояния HTTP 200 и список передаваемых подписок клиента с датой истечения срока действия токена передачи и минимальным количеством рабочих мест, необходимых в заказе на передачу. Клиент может иметь дополнительные подписки, которые не подлежат передаче.

{
  "kind": "reseller#subscriptions",
  "subscriptions": [
    {
      "kind": "subscriptions#subscription",
      "customerId": "custId-6543",
      "subscriptionId": "432",
      "skuId": "1010020028",
      "billingMethod": "ONLINE",
      "creationTime": "1331647980142",
      "plan": {
        "planName": "ANNUAL",
        "isCommitmentPlan": true,
        "commitmentInterval": {
          "startTime": "1331647980142",
          "endTime": "1363183980142"
        }
      },
      "seats": {
        "kind": "subscriptions#seats",
        "numberOfSeats": 10,
        "maximumNumberOfSeats": 500,
        "licensedNumberOfSeats": 10
      },
      "trialSettings": {
        "isInTrial": false
      },
      "renewalSettings": {
        "kind": "subscriptions#renewalSettings",
        "renewalType": "SWITCH_TO_PAY_AS_YOU_GO"
      },
      "transferInfo": {
        "transferabilityExpirationTime": "1333183980142",
        "minimumTransferableSeats": "20"
      },
      "purchaseOrderId": "PO_890",
      "status": "ACTIVE",
      "resourceUiUrl": "URL to customer's Subscriptions page in the Admin console",
      "skuName": "Google Workspace Business Standard"
    },
    {
      "kind": "subscriptions#subscription",
      "customerId": "custId-6543",
      "subscriptionId": "140",
      "skuId": "1010020028",
      "creationTime": "1329389322728",
      "plan": {
        "planName": "FLEXIBLE",
        "isCommitmentPlan": false
      },
      "seats": {
        "kind": "subscriptions#seats",
        "maximumNumberOfSeats": 50
        "licensedNumberOfSeats": 10
      },
      "trialSettings": {
        "isInTrial": false,
        "trialEndTime": "1331877480016"
      },
      "renewalSettings": {
        "kind": "subscriptions#renewalSettings",
        "renewalType": "SWITCH_TO_PAY_AS_YOU_GO"
      },
      "transferInfo": {
        "transferabilityExpirationTime": "1333183780159",
        "minimumTransferableSeats": "10"
      },
      "purchaseOrderId": "",
      "status": "ACTIVE",
      "resourceUiUrl": "URL to customer's Subscriptions page in the Admin console",
      "skuName": "Google Workspace Business Standard"
    },
  ],
  "nextPageToken": "token"
}

Если вы планируете перенести эти подписки с помощью пакетной операции, перенесите все подписки. Передача каждой подписки по одной приводит к ошибке. Кроме того, пакетная операция передает только подписки со статусом ACTIVE . Дополнительную информацию см. в разделе Передача подписки .

Получить все подписки реселлера

Чтобы получить все успешно заказанные или переданные реселлером подписки, используйте следующий HTTP-запрос GET и включите токен авторизации.

GET https://reseller.googleapis.com/apps/reseller/v1/subscriptions?customerNamePrefix=PREFIX &pageToken=TOKEN&maxResults=MAX_NUMBER

Замените следующее:

  • PREFIX : начало имени клиента, подписки которого вы ищете.
  • TOKEN : токен, идентифицирующий конкретную страницу результатов, которую должен вернуть сервер.
  • MAX_NUMBER : максимальное количество результатов, возвращаемых на странице ответа.

Эта операция может использовать область доступа OAuth только для чтения. customerNamePrefix , pageToken и maxResults являются необязательными строками запроса.

В следующем примере извлекаются все подписки реселлера, принадлежащие клиентам, имена которых начинаются с «экзамен»:

GET https://reseller.googleapis.com/apps/reseller/v1/subscriptions?customerNamePrefix=exam

{
  "kind": "reseller#subscriptions",
  "subscriptions": [
    {
      "kind": "subscriptions#subscription",
      "customerId": "C0123456",
      "subscriptionId": "123",
      "skuId": "1010020028",
      "creationTime": "1331647980142",
      "billingMethod": "ONLINE",
      "plan": {
        "planName": "ANNUAL",
        "isCommitmentPlan": true,
        "commitmentInterval": {
          "startTime": "1331647980142",
          "endTime": "1363183980142"
        }
      },
      "seats": {
        "kind": "subscriptions#seats",
        "numberOfSeats": 10,
        "licensedNumberOfSeats": 10
      },
      "trialSettings": {
        "isInTrial": false
      },
      "renewalSettings": {
        "kind": "subscriptions#renewalSettings",
        "renewalType": "SWITCH_TO_PAY_AS_YOU_GO"
      },
      "purchaseOrderId": "PO_135",
      "status": "ACTIVE",
      "resourceUiUrl": "URL to customer's Subscriptions page in the Admin console",
      "skuName": "Google Workspace Business Standard"
    },
    {
      "kind": "subscriptions#subscription",
      "customerId": "custId-5678",
      "subscriptionId": "1404686",
      "skuId": "1010020028",
      "billingMethod": "ONLINE",
      "creationTime": "1329389322728",
      "plan": {
        "planName": "FLEXIBLE",
        "isCommitmentPlan": false
      },
      "seats": {
        "kind": "subscriptions#seats",
        "maximumNumberOfSeats": 50,
        "licensedNumberOfSeats": 10
      },
      "trialSettings": {
        "isInTrial": false,
        "trialEndTime": "1331877480016"
      },
      "renewalSettings": {
        "kind": "subscriptions#renewalSettings",
        "renewalType": "AUTO_RENEW"
      },
      "purchaseOrderId": "",
      "status": "ACTIVE",
      "resourceUiUrl": "URL to customer's Subscriptions page in the Admin console",
      "skuName": "Google Workspace Business Standard"
    },
  ],
  "nextPageToken": "token"
}

Обновить план подписки

Обновление планов Google Workspace различается в зависимости от плана. Прежде чем обновлять план, учтите следующее:

  • Когда вы создаете подписку и клиент соответствует требованиям, план подписки может быть 30-дневной пробной версией. Как гибкий план оплаты, так и план оплаты с годовыми обязательствами могут представлять собой 30-дневную бесплатную пробную версию. Во время пробного периода вы можете менять план оплаты подписки на гибкий или годовой план так часто, как это необходимо. Но после окончания пробного периода и план становится активным, его обновление осуществляется по тем же правилам, что и активные планы других подписок. Чтобы немедленно перевести пробную подписку на активный план, запустите платную услугу из 30-дневной бесплатной пробной подписки . Дополнительную информацию о 30-дневной пробной версии и правилах квалификации клиентов см. в справочном центре администрирования .

  • Вы можете обновить гибкий план до годового плана обязательств.

  • Вы не можете обновить годовой план обязательств.

  • Не все планы работают со всеми продуктами. Дополнительные сведения о продуктах, используемых в этих планах, см. в разделе Продукты и SKU .

Чтобы обновить план 30-дневной пробной версии или подписку на гибкий план до годового плана обязательств, используйте следующий HTTP-запрос POST :

POST https://reseller.googleapis.com/apps/reseller/v1/customers/CUSTOMER_ID/subscriptions/SUBSCRIPTION_ID/changePlan

Замените следующее:

  • CUSTOMER_ID : либо основное доменное имя клиента, либо уникальный идентификатор клиента.
  • SUBSCRIPTION_ID : идентификатор подписки, уникальный для каждого клиента. Это значение можно получить с помощью метода Получить все подписки реселлера .

В следующем примере подписка обновляется с помощью subscriptionId со значением 123. customerId — C0123456.

POST https://reseller.googleapis.com/apps/reseller/v1/customers/C0123456/subscriptions/123/changePlan

Тело запроса имеет следующее: 

{
  "kind": "reseller#changePlanRequest",
  "planName": "ANNUAL_MONTHLY_PAY",
  "seats": {
    "kind": "subscriptions#seats",
    "numberOfSeats": 10
  },
  "purchaseOrderId": "123_March2012"
}

Успешный ответ возвращает код состояния HTTP 201 и возвращает обновленные настройки плана подписки: 

{
  "kind": "reseller#subscription",
  "customerId": "C0123456",
  "subscriptionId": "123",
  "skuId": "1010020028",
  "creationTime": "1331647980142",
  "plan": {
    "planName": "ANNUAL",
    "isCommitmentPlan": true,
    "commitmentInterval": {
      "startTime": "1331647980142",
      "endTime": "1363183980142"
    }
  },
  "seats": {
    "kind": "subscriptions#seats",
    "numberOfSeats": 10,
    "licensedNumberOfSeats": 10
  },
  "trialSettings": {
    "isInTrial": false
  },
  "renewalSettings": {
    "kind": "subscriptions#renewalSettings",
    "renewalType": "SWITCH_TO_PAY_AS_YOU_GO"
  },
  "purchaseOrderId": "123_March2012",
  "status": "ACTIVE",
  "skuName": "Google Workspace Business Standard"
}

Обновление мест подписки

При обновлении подписки на годовой план с обязательством используются другие свойства подписки, чем при обновлении подписки на гибкий план Google Workspace.

Обновление мест для подписки на годовой план

Чтобы обновить настройки пользовательской лицензии годовой подписки, используйте следующий HTTP-запрос POST : 

POST https://reseller.googleapis.com/apps/reseller/v1/customers/CUSTOMER_ID/subscriptions/SUBSCRIPTION_ID/changeSeats

Замените следующее:

  • CUSTOMER_ID : либо основное доменное имя клиента, либо уникальный идентификатор клиента.
  • SUBSCRIPTION_ID : идентификатор подписки, уникальный для каждого клиента. Это значение можно получить с помощью метода Получить все подписки реселлера .

В следующем примере подписка обновляется с использованием subscriptionId 123. customerId — C0123456. Тело запроса различается в зависимости от типа плана: 

POST https://reseller.googleapis.com/apps/reseller/v1/customers/C0123456/subscriptions/123/changeSeats

Подписка на годовой план обязательств Google Workspace использует этот текст запроса для обновления количества пользовательских лицензий. Значение numberOfSeats является итоговым. Например, если у вас ранее было 10 пользовательских лицензий и у вас есть заказ клиента на 5 новых лицензий, общее количество в теле запроса для numberOfSeats равно 15, как показано в следующем примере: 

{
    "kind": "subscriptions#seats",
    "numberOfSeats": 15
}

Обновите места для подписки на гибкий план

Подписка на гибкий план Google Workspace использует тело запроса для обновления пользовательских лицензий. Значение maximumNumberOfSeats — это общее количество существующих и новых лицензий. Это максимальное количество пользовательских лицензий, которые может предоставить учетная запись. 

{
  "kind": "subscriptions#seats",
  "maximumNumberOfSeats": 15
}

Успешный ответ возвращает код состояния HTTP 201 и обновленные настройки лицензии на подписку: 

{
  "kind": "reseller#subscription",
  "customerId": "C0123456",
  "subscriptionId": "123",
  "skuId": "1010020028",
  "creationTime": "1331647980142",
  "plan": {
    "planName": "FLEXIBLE",
    "isCommitmentPlan": false
  },
  "seats": {
    "kind": "subscriptions#seats",
    "maximumNumberOfSeats": 15,
    "licensedNumberOfSeats": 10
  },
  "trialSettings": {
    "isInTrial": false
  },
  "skuName": "Google Workspace Business Standard"
}

Обновление настроек продления подписки

Чтобы обновить параметры продления годовой подписки, используйте следующий HTTP-запрос POST : 

POST https://reseller.googleapis.com/apps/reseller/v1/customers/CUSTOMER_ID/subscriptions/SUBSCRIPTION_ID/changeRenewalSettings

Замените следующее:

  • CUSTOMER_ID : либо основное доменное имя клиента, либо уникальный идентификатор клиента.
  • SUBSCRIPTION_ID : идентификатор подписки, уникальный для каждого клиента. Это значение можно получить с помощью метода Получить все подписки реселлера .

Ниже приведен пример тела запроса: 

{
  "kind": "subscriptions#renewalSettings",
  "renewalType": "SWITCH_TO_PAY_AS_YOU_GO"
}

Значение свойства renewalType может быть любым из следующих:

  • AUTO_RENEW_YEARLY_PAY : в конце интервала действия годового плана автоматически продлевается план подписки на ANNUAL_YEARLY_PAY с тем же numberOfSeats .
  • AUTO_RENEW_MONTHLY_PAY : в конце интервала годового плана обязательств автоматически продлевается план подписки на ANNUAL_MONTHLY_PAY с тем же numberOfSeats .
  • RENEW_CURRENT_USERS_YEARLY_PAY : в конце периода действия годового плана обновите план подписки на ANNUAL_YEARLY_PAY но используйте общее количество текущих активных пользовательских лицензий. Это настройка по умолчанию для активных планов годовых обязательств (оплачивается ежегодно).
  • RENEW_CURRENT_USERS_MONTHLY_PAY : в конце интервала действия годового плана обновите план подписки как ANNUAL_MONTHLY_PAY но используйте общее количество текущих активных пользовательских лицензий. Это настройка по умолчанию для активных планов годовых обязательств (оплачивается ежемесячно).
  • RENEW_ON_PROPOSED_OFFER : в конце интервала текущего плана обязательств продлите последнее предложение по продлению, указав число мест в качестве количества текущих активных пользовательских лицензий или предложенное обязательство по предложению, в зависимости от того, какое из них больше.
  • SWITCH_TO_PAY_AS_YOU_GO : в конце интервала годового плана обязательств измените годовой план обязательств на гибкий план.
  • CANCEL : по истечении годового плана подписки подписка приостанавливается. Чтобы понять, как снять блокировку, обратитесь в справочный центр администрации .

В случае успешного ответа возвращается код состояния HTTP 201 и обновленные настройки продления подписки: 

{
  "kind": "reseller#subscription",
  "customerId": "C0123456",
  "subscriptionId": "123",
  "skuId": "1010020028",
  "creationTime": "1331647980142",
  "plan": {
    "planName": "ANNUAL",
    "isCommitmentPlan": true,
    "commitmentInterval": {
      "startTime": "1331647980142",
      "endTime": "1363183980142"
    }
  },
  "seats": {
    "kind": "subscriptions#seats",
    "numberOfSeats": 15,
    "licensedNumberOfSeats": 15
  },
  "trialSettings": {
    "isInTrial": false
  },
  "renewalSettings": {
    "kind": "subscriptions#renewalSettings",
    "renewalType": "SWITCH_TO_PAY_AS_YOU_GO"
  },
  "skuName": "Google Workspace Business Standard"
}

Запустите платный сервис с бесплатной пробной подписки

Чтобы немедленно перенести 30-дневную бесплатную пробную подписку на платную подписку на службу, если для пробной подписки уже настроен план оплаты, используйте следующий HTTP-запрос POST . 

POST https://reseller.googleapis.com/apps/reseller/v1/customers/CUSTOMER_ID/subscriptions/SUBSCRIPTION_ID/startPaidService

Замените следующее:

  • CUSTOMER_ID : либо основное доменное имя клиента, либо уникальный идентификатор клиента.
  • SUBSCRIPTION_ID : идентификатор подписки, уникальный для каждого клиента. Это значение можно получить с помощью метода Получить все подписки реселлера .

В следующем примере в качестве customerId используется C0123456, а значение subscriptionId равно 123: 

POST https://reseller.googleapis.com/apps/reseller/v1/customers/C0123456/subscriptions/123/startPaidService

Эта операция не имеет параметров в теле запроса.

Успешный ответ возвращает код состояния HTTP 201 и обновленные настройки подписки: 

{
  "kind": "reseller#subscription",
  "customerId": "C0123456",
  "subscriptionId": "123",
  "skuId": "1010020028",
  "creationTime": "1331647980142",
  "plan": {
    "planName": "ANNUAL",
    "isCommitmentPlan": true,
    "commitmentInterval": {
      "startTime": "1331647980142",
      "endTime": "1363183980142"
    }
  },
  "seats": {
    "kind": "subscriptions#seats",
    "numberOfSeats": 15,
    "licensedNumberOfSeats": 15
  },
  "trialSettings": {
    "isInTrial": false
  },
  "renewalSettings": {
    "kind": "subscriptions#renewalSettings",
    "renewalType": "SWITCH_TO_PAY_AS_YOU_GO"
  },
  "skuName": "Google Workspace Business Standard"
}

Обновить или понизить подписку

Вы не можете понизить годовые планы в середине срока их действия, а также не можете запланировать переход на более раннюю версию с помощью настроек продления. Мы рекомендуем вам установить параметры продления, чтобы переключиться на FLEXIBLE , а затем перейти на более раннюю версию после продления.

Чтобы обновить или понизить подписку, создайте новую подписку с идентификатором skuId , до которого вы хотите обновить или понизить версию. 

POST https://reseller.googleapis.com/apps/reseller/v1/customers/CUSTOMER_ID/subscriptions

Замените следующее:

  • CUSTOMER_ID : либо основное доменное имя клиента, либо уникальный идентификатор клиента.

Этот вызов завершает предыдущую подписку и создает новую.

Дополнительную информацию об обновлениях и понижениях версий можно найти на странице «Продукты и SKU».