Skip to content

Latest commit

 

History

History
248 lines (171 loc) · 8.04 KB

subscription-group-status.md

File metadata and controls

248 lines (171 loc) · 8.04 KB
Raw

Subscription Group Status

subscriptionGroupStatusController := client.SubscriptionGroupStatusController()

Class Name

SubscriptionGroupStatusController

Methods

Cancel Subscriptions in Group

This endpoint will immediately cancel all subscriptions within the specified group. The group is identified by it's uid passed in the URL. To successfully cancel the group, the primary subscription must be on automatic billing. The group members as well must be on automatic billing or they must be prepaid.

In order to cancel a subscription group while also charging for any unbilled usage on metered or prepaid components, the charge_unbilled_usage=true parameter must be included in the request.

CancelSubscriptionsInGroup(
    ctx context.Context,
    uid string,
    body *models.CancelGroupedSubscriptionsRequest) (
    http.Response,
    error)

Parameters

Parameter Type Tags Description
uid string Template, Required The uid of the subscription group
body *models.CancelGroupedSubscriptionsRequest Body, Optional -

Response Type

``

Example Usage

ctx := context.Background()

uid := "uid0"

body := models.CancelGroupedSubscriptionsRequest{
    ChargeUnbilledUsage: models.ToPointer(true),
}

resp, err := subscriptionGroupStatusController.CancelSubscriptionsInGroup(ctx, uid, &body)
if err != nil {
    log.Fatalln(err)
} else {
    fmt.Println(resp.StatusCode)
}

Errors

HTTP Status Code Error Description Exception Class
422 Unprocessable Entity (WebDAV) ErrorListResponseException

Initiate Delayed Cancellation for Group

This endpoint will schedule all subscriptions within the specified group to be canceled at the end of their billing period. The group is identified by it's uid passed in the URL.

All subscriptions in the group must be on automatic billing in order to successfully cancel them, and the group must not be in a "past_due" state.

InitiateDelayedCancellationForGroup(
    ctx context.Context,
    uid string) (
    http.Response,
    error)

Parameters

Parameter Type Tags Description
uid string Template, Required The uid of the subscription group

Response Type

``

Example Usage

ctx := context.Background()

uid := "uid0"

resp, err := subscriptionGroupStatusController.InitiateDelayedCancellationForGroup(ctx, uid)
if err != nil {
    log.Fatalln(err)
} else {
    fmt.Println(resp.StatusCode)
}

Errors

HTTP Status Code Error Description Exception Class
422 Unprocessable Entity (WebDAV) ErrorListResponseException

Cancel Delayed Cancellation for Group

Removing the delayed cancellation on a subscription group will ensure that the subscriptions do not get canceled at the end of the period. The request will reset the cancel_at_end_of_period flag to false on each member in the group.

CancelDelayedCancellationForGroup(
    ctx context.Context,
    uid string) (
    http.Response,
    error)

Parameters

Parameter Type Tags Description
uid string Template, Required The uid of the subscription group

Response Type

``

Example Usage

ctx := context.Background()

uid := "uid0"

resp, err := subscriptionGroupStatusController.CancelDelayedCancellationForGroup(ctx, uid)
if err != nil {
    log.Fatalln(err)
} else {
    fmt.Println(resp.StatusCode)
}

Errors

HTTP Status Code Error Description Exception Class
422 Unprocessable Entity (WebDAV) ErrorListResponseException

Reactivate Subscription Group

This endpoint will attempt to reactivate or resume a cancelled subscription group. Upon reactivation, any canceled invoices created after the beginning of the primary subscription's billing period will be reopened and payment will be attempted on them. If the subscription group is being reactivated (as opposed to resumed), new charges will also be assessed for the new billing period.

Whether a subscription group is reactivated (a new billing period is created) or resumed (the current billing period is respected) will depend on the parameters that are sent with the request as well as the date of the request relative to the primary subscription's period.

Reactivating within the current period

If a subscription group is cancelled and reactivated within the primary subscription's current period, we can choose to either start a new billing period or maintain the existing one. If we want to maintain the existing billing period the resume=true option must be passed in request parameters.

An exception to the above are subscriptions that are on calendar billing. These subscriptions cannot be reactivated within the current period. If the resume=true option is not passed the request will return an error.

The resume_members option is ignored in this case. All eligible group members will be automatically resumed.

Reactivating beyond the current period

In this case, a subscription group can only be reactivated with a new billing period. If the resume=true option is passed it will be ignored.

Member subscriptions can have billing periods that are longer than the primary (e.g. a monthly primary with annual group members). If the primary subscription in a group cannot be reactivated within the current period, but other group members can be, passing resume_members=true will resume the existing billing period for eligible group members. The primary subscription will begin a new billing period.

For calendar billing subscriptions, the new billing period created will be a partial one, spanning from the date of reactivation to the next corresponding calendar renewal date.

ReactivateSubscriptionGroup(
    ctx context.Context,
    uid string,
    body *models.ReactivateSubscriptionGroupRequest) (
    models.ApiResponse[models.ReactivateSubscriptionGroupResponse],
    error)

Parameters

Parameter Type Tags Description
uid string Template, Required The uid of the subscription group
body *models.ReactivateSubscriptionGroupRequest Body, Optional -

Response Type

models.ReactivateSubscriptionGroupResponse

Example Usage

ctx := context.Background()

uid := "uid0"

body := models.ReactivateSubscriptionGroupRequest{
    Resume:        models.ToPointer(true),
}

apiResponse, err := subscriptionGroupStatusController.ReactivateSubscriptionGroup(ctx, uid, &body)
if err != nil {
    log.Fatalln(err)
} else {
    // Printing the result and response
    fmt.Println(apiResponse.Data)
    fmt.Println(apiResponse.Response.StatusCode)
}

Example Response (as JSON)

{
  "uid": "grp_93wgm89cbjkw6",
  "scheme": 1,
  "customer_id": 1,
  "payment_profile_id": 1,
  "subscription_ids": [
    1,
    2
  ],
  "primary_subscription_id": 1,
  "next_assessment_at": "2020-06-18T12:00:00-04:00",
  "state": "active",
  "cancel_at_end_of_period": false
}

Errors

HTTP Status Code Error Description Exception Class
422 Unprocessable Entity (WebDAV) ErrorListResponseException