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

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

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

Чтобы получить успешно заказанную или переданную подписку, используйте следующий 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 и список подписок и настроек клиента. Список подписок может включать продукты, управление которыми в этой версии Reseller 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 являются необязательными строками запроса.

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

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-дневном пробном периоде и правилах квалификации клиентов см. в справочном центре администрирования .

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

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

  • Не все тарифные планы совместимы со всеми продуктами. Подробнее о продуктах, используемых в этих тарифных планах, см. в разделе «Продукты и артикулы» .

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

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.

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

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

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"
}

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

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

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 : В конце интервала текущего плана обязательств продлить подписку по последнему предложению о продлении, указав numberOfSeats равным числу текущих активных пользовательских лицензий или предложенному обязательству по предложению, в зависимости от того, какое из них больше.
  • 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-дневную бесплатную пробную подписку в платную подписку на сервис, если для пробной подписки уже настроен тарифный план, используйте следующий запрос POST HTTP. 

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 : либо основное доменное имя клиента, либо уникальный идентификатор клиента.

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

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