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

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

Восстановить подписку

Для получения информации об успешно оформленной или перенесенной подписке используйте следующий 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&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 являются необязательными строками запроса.

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

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

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