Documentation
¶
Index ¶
- type Error
- type SubscriptionDeleteResponse
- type SubscriptionDeleteResponseEnvelope
- type SubscriptionDeleteResponseEnvelopeErrors
- type SubscriptionDeleteResponseEnvelopeMessages
- type SubscriptionDeleteResponseEnvelopeSuccess
- type SubscriptionGetResponse
- type SubscriptionGetResponseEnvelope
- type SubscriptionGetResponseEnvelopeErrors
- type SubscriptionGetResponseEnvelopeMessages
- type SubscriptionGetResponseEnvelopeSuccess
- type SubscriptionListResponse
- type SubscriptionListResponseApp
- type SubscriptionListResponseComponentValue
- type SubscriptionListResponseEnvelope
- type SubscriptionListResponseEnvelopeErrors
- type SubscriptionListResponseEnvelopeMessages
- type SubscriptionListResponseEnvelopeResultInfo
- type SubscriptionListResponseEnvelopeSuccess
- type SubscriptionListResponseFrequency
- type SubscriptionListResponseRatePlan
- type SubscriptionListResponseState
- type SubscriptionListResponseZone
- type SubscriptionNewParams
- type SubscriptionNewParamsApp
- type SubscriptionNewParamsComponentValue
- type SubscriptionNewParamsFrequency
- type SubscriptionNewParamsRatePlan
- type SubscriptionNewParamsZone
- type SubscriptionNewResponse
- type SubscriptionNewResponseEnvelope
- type SubscriptionNewResponseEnvelopeErrors
- type SubscriptionNewResponseEnvelopeMessages
- type SubscriptionNewResponseEnvelopeSuccess
- type SubscriptionService
- func (r *SubscriptionService) Delete(ctx context.Context, accountIdentifier string, subscriptionIdentifier string, ...) (res *SubscriptionDeleteResponse, err error)
- func (r *SubscriptionService) Get(ctx context.Context, identifier string, opts ...option.RequestOption) (res *SubscriptionGetResponse, err error)
- func (r *SubscriptionService) List(ctx context.Context, accountIdentifier string, opts ...option.RequestOption) (res *[]SubscriptionListResponse, err error)
- func (r *SubscriptionService) New(ctx context.Context, identifier string, body SubscriptionNewParams, ...) (res *SubscriptionNewResponse, err error)
- func (r *SubscriptionService) Update(ctx context.Context, accountIdentifier string, subscriptionIdentifier string, ...) (res *SubscriptionUpdateResponse, err error)
- type SubscriptionUpdateParams
- type SubscriptionUpdateParamsApp
- type SubscriptionUpdateParamsComponentValue
- type SubscriptionUpdateParamsFrequency
- type SubscriptionUpdateParamsRatePlan
- type SubscriptionUpdateParamsZone
- type SubscriptionUpdateResponse
- type SubscriptionUpdateResponseEnvelope
- type SubscriptionUpdateResponseEnvelopeErrors
- type SubscriptionUpdateResponseEnvelopeMessages
- type SubscriptionUpdateResponseEnvelopeSuccess
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type SubscriptionDeleteResponse ¶
type SubscriptionDeleteResponse struct { // Subscription identifier tag. SubscriptionID string `json:"subscription_id"` JSON subscriptionDeleteResponseJSON `json:"-"` }
func (*SubscriptionDeleteResponse) UnmarshalJSON ¶
func (r *SubscriptionDeleteResponse) UnmarshalJSON(data []byte) (err error)
type SubscriptionDeleteResponseEnvelope ¶
type SubscriptionDeleteResponseEnvelope struct { Errors []SubscriptionDeleteResponseEnvelopeErrors `json:"errors,required"` Messages []SubscriptionDeleteResponseEnvelopeMessages `json:"messages,required"` Result SubscriptionDeleteResponse `json:"result,required"` // Whether the API call was successful Success SubscriptionDeleteResponseEnvelopeSuccess `json:"success,required"` JSON subscriptionDeleteResponseEnvelopeJSON `json:"-"` }
func (*SubscriptionDeleteResponseEnvelope) UnmarshalJSON ¶
func (r *SubscriptionDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type SubscriptionDeleteResponseEnvelopeErrors ¶
type SubscriptionDeleteResponseEnvelopeErrors struct { Code int64 `json:"code,required"` Message string `json:"message,required"` JSON subscriptionDeleteResponseEnvelopeErrorsJSON `json:"-"` }
func (*SubscriptionDeleteResponseEnvelopeErrors) UnmarshalJSON ¶
func (r *SubscriptionDeleteResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type SubscriptionDeleteResponseEnvelopeMessages ¶
type SubscriptionDeleteResponseEnvelopeMessages struct { Code int64 `json:"code,required"` Message string `json:"message,required"` JSON subscriptionDeleteResponseEnvelopeMessagesJSON `json:"-"` }
func (*SubscriptionDeleteResponseEnvelopeMessages) UnmarshalJSON ¶
func (r *SubscriptionDeleteResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type SubscriptionDeleteResponseEnvelopeSuccess ¶
type SubscriptionDeleteResponseEnvelopeSuccess bool
Whether the API call was successful
const (
SubscriptionDeleteResponseEnvelopeSuccessTrue SubscriptionDeleteResponseEnvelopeSuccess = true
)
type SubscriptionGetResponse ¶
type SubscriptionGetResponse interface {
ImplementsSubscriptionsSubscriptionGetResponse()
}
Union satisfied by subscriptions.SubscriptionGetResponseUnknown or shared.UnionString.
type SubscriptionGetResponseEnvelope ¶
type SubscriptionGetResponseEnvelope struct { Errors []SubscriptionGetResponseEnvelopeErrors `json:"errors,required"` Messages []SubscriptionGetResponseEnvelopeMessages `json:"messages,required"` Result SubscriptionGetResponse `json:"result,required"` // Whether the API call was successful Success SubscriptionGetResponseEnvelopeSuccess `json:"success,required"` JSON subscriptionGetResponseEnvelopeJSON `json:"-"` }
func (*SubscriptionGetResponseEnvelope) UnmarshalJSON ¶
func (r *SubscriptionGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type SubscriptionGetResponseEnvelopeErrors ¶
type SubscriptionGetResponseEnvelopeErrors struct { Code int64 `json:"code,required"` Message string `json:"message,required"` JSON subscriptionGetResponseEnvelopeErrorsJSON `json:"-"` }
func (*SubscriptionGetResponseEnvelopeErrors) UnmarshalJSON ¶
func (r *SubscriptionGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type SubscriptionGetResponseEnvelopeMessages ¶
type SubscriptionGetResponseEnvelopeMessages struct { Code int64 `json:"code,required"` Message string `json:"message,required"` JSON subscriptionGetResponseEnvelopeMessagesJSON `json:"-"` }
func (*SubscriptionGetResponseEnvelopeMessages) UnmarshalJSON ¶
func (r *SubscriptionGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type SubscriptionGetResponseEnvelopeSuccess ¶
type SubscriptionGetResponseEnvelopeSuccess bool
Whether the API call was successful
const (
SubscriptionGetResponseEnvelopeSuccessTrue SubscriptionGetResponseEnvelopeSuccess = true
)
type SubscriptionListResponse ¶
type SubscriptionListResponse struct { // Subscription identifier tag. ID string `json:"id"` App SubscriptionListResponseApp `json:"app"` // The list of add-ons subscribed to. ComponentValues []SubscriptionListResponseComponentValue `json:"component_values"` // The monetary unit in which pricing information is displayed. Currency string `json:"currency"` // The end of the current period and also when the next billing is due. CurrentPeriodEnd time.Time `json:"current_period_end" format:"date-time"` // When the current billing period started. May match initial_period_start if this // is the first period. CurrentPeriodStart time.Time `json:"current_period_start" format:"date-time"` // How often the subscription is renewed automatically. Frequency SubscriptionListResponseFrequency `json:"frequency"` // The price of the subscription that will be billed, in US dollars. Price float64 `json:"price"` // The rate plan applied to the subscription. RatePlan SubscriptionListResponseRatePlan `json:"rate_plan"` // The state that the subscription is in. State SubscriptionListResponseState `json:"state"` // A simple zone object. May have null properties if not a zone subscription. Zone SubscriptionListResponseZone `json:"zone"` JSON subscriptionListResponseJSON `json:"-"` }
func (*SubscriptionListResponse) UnmarshalJSON ¶
func (r *SubscriptionListResponse) UnmarshalJSON(data []byte) (err error)
type SubscriptionListResponseApp ¶
type SubscriptionListResponseApp struct { // app install id. InstallID string `json:"install_id"` JSON subscriptionListResponseAppJSON `json:"-"` }
func (*SubscriptionListResponseApp) UnmarshalJSON ¶
func (r *SubscriptionListResponseApp) UnmarshalJSON(data []byte) (err error)
type SubscriptionListResponseComponentValue ¶
type SubscriptionListResponseComponentValue struct { // The default amount assigned. Default float64 `json:"default"` // The name of the component value. Name string `json:"name"` // The unit price for the component value. Price float64 `json:"price"` // The amount of the component value assigned. Value float64 `json:"value"` JSON subscriptionListResponseComponentValueJSON `json:"-"` }
A component value for a subscription.
func (*SubscriptionListResponseComponentValue) UnmarshalJSON ¶
func (r *SubscriptionListResponseComponentValue) UnmarshalJSON(data []byte) (err error)
type SubscriptionListResponseEnvelope ¶
type SubscriptionListResponseEnvelope struct { Errors []SubscriptionListResponseEnvelopeErrors `json:"errors,required"` Messages []SubscriptionListResponseEnvelopeMessages `json:"messages,required"` Result []SubscriptionListResponse `json:"result,required,nullable"` // Whether the API call was successful Success SubscriptionListResponseEnvelopeSuccess `json:"success,required"` ResultInfo SubscriptionListResponseEnvelopeResultInfo `json:"result_info"` JSON subscriptionListResponseEnvelopeJSON `json:"-"` }
func (*SubscriptionListResponseEnvelope) UnmarshalJSON ¶
func (r *SubscriptionListResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type SubscriptionListResponseEnvelopeErrors ¶
type SubscriptionListResponseEnvelopeErrors struct { Code int64 `json:"code,required"` Message string `json:"message,required"` JSON subscriptionListResponseEnvelopeErrorsJSON `json:"-"` }
func (*SubscriptionListResponseEnvelopeErrors) UnmarshalJSON ¶
func (r *SubscriptionListResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type SubscriptionListResponseEnvelopeMessages ¶
type SubscriptionListResponseEnvelopeMessages struct { Code int64 `json:"code,required"` Message string `json:"message,required"` JSON subscriptionListResponseEnvelopeMessagesJSON `json:"-"` }
func (*SubscriptionListResponseEnvelopeMessages) UnmarshalJSON ¶
func (r *SubscriptionListResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type SubscriptionListResponseEnvelopeResultInfo ¶
type SubscriptionListResponseEnvelopeResultInfo struct { // Total number of results for the requested service Count float64 `json:"count"` // Current page within paginated list of results Page float64 `json:"page"` // Number of results per page of results PerPage float64 `json:"per_page"` // Total results available without any search parameters TotalCount float64 `json:"total_count"` JSON subscriptionListResponseEnvelopeResultInfoJSON `json:"-"` }
func (*SubscriptionListResponseEnvelopeResultInfo) UnmarshalJSON ¶
func (r *SubscriptionListResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error)
type SubscriptionListResponseEnvelopeSuccess ¶
type SubscriptionListResponseEnvelopeSuccess bool
Whether the API call was successful
const (
SubscriptionListResponseEnvelopeSuccessTrue SubscriptionListResponseEnvelopeSuccess = true
)
type SubscriptionListResponseFrequency ¶
type SubscriptionListResponseFrequency string
How often the subscription is renewed automatically.
const ( SubscriptionListResponseFrequencyWeekly SubscriptionListResponseFrequency = "weekly" SubscriptionListResponseFrequencyMonthly SubscriptionListResponseFrequency = "monthly" SubscriptionListResponseFrequencyQuarterly SubscriptionListResponseFrequency = "quarterly" SubscriptionListResponseFrequencyYearly SubscriptionListResponseFrequency = "yearly" )
type SubscriptionListResponseRatePlan ¶
type SubscriptionListResponseRatePlan struct { // The ID of the rate plan. ID interface{} `json:"id"` // The currency applied to the rate plan subscription. Currency string `json:"currency"` // Whether this rate plan is managed externally from Cloudflare. ExternallyManaged bool `json:"externally_managed"` // Whether a rate plan is enterprise-based (or newly adopted term contract). IsContract bool `json:"is_contract"` // The full name of the rate plan. PublicName string `json:"public_name"` // The scope that this rate plan applies to. Scope string `json:"scope"` // The list of sets this rate plan applies to. Sets []string `json:"sets"` JSON subscriptionListResponseRatePlanJSON `json:"-"` }
The rate plan applied to the subscription.
func (*SubscriptionListResponseRatePlan) UnmarshalJSON ¶
func (r *SubscriptionListResponseRatePlan) UnmarshalJSON(data []byte) (err error)
type SubscriptionListResponseState ¶
type SubscriptionListResponseState string
The state that the subscription is in.
const ( SubscriptionListResponseStateTrial SubscriptionListResponseState = "Trial" SubscriptionListResponseStateProvisioned SubscriptionListResponseState = "Provisioned" SubscriptionListResponseStatePaid SubscriptionListResponseState = "Paid" SubscriptionListResponseStateAwaitingPayment SubscriptionListResponseState = "AwaitingPayment" SubscriptionListResponseStateCancelled SubscriptionListResponseState = "Cancelled" SubscriptionListResponseStateFailed SubscriptionListResponseState = "Failed" SubscriptionListResponseStateExpired SubscriptionListResponseState = "Expired" )
type SubscriptionListResponseZone ¶
type SubscriptionListResponseZone struct { // Identifier ID string `json:"id"` // The domain name Name string `json:"name"` JSON subscriptionListResponseZoneJSON `json:"-"` }
A simple zone object. May have null properties if not a zone subscription.
func (*SubscriptionListResponseZone) UnmarshalJSON ¶
func (r *SubscriptionListResponseZone) UnmarshalJSON(data []byte) (err error)
type SubscriptionNewParams ¶
type SubscriptionNewParams struct { App param.Field[SubscriptionNewParamsApp] `json:"app"` // The list of add-ons subscribed to. ComponentValues param.Field[[]SubscriptionNewParamsComponentValue] `json:"component_values"` // How often the subscription is renewed automatically. Frequency param.Field[SubscriptionNewParamsFrequency] `json:"frequency"` // The rate plan applied to the subscription. RatePlan param.Field[SubscriptionNewParamsRatePlan] `json:"rate_plan"` // A simple zone object. May have null properties if not a zone subscription. Zone param.Field[SubscriptionNewParamsZone] `json:"zone"` }
func (SubscriptionNewParams) MarshalJSON ¶
func (r SubscriptionNewParams) MarshalJSON() (data []byte, err error)
type SubscriptionNewParamsApp ¶
type SubscriptionNewParamsApp struct { // app install id. InstallID param.Field[string] `json:"install_id"` }
func (SubscriptionNewParamsApp) MarshalJSON ¶
func (r SubscriptionNewParamsApp) MarshalJSON() (data []byte, err error)
type SubscriptionNewParamsComponentValue ¶
type SubscriptionNewParamsComponentValue struct { // The default amount assigned. Default param.Field[float64] `json:"default"` // The name of the component value. Name param.Field[string] `json:"name"` // The unit price for the component value. Price param.Field[float64] `json:"price"` // The amount of the component value assigned. Value param.Field[float64] `json:"value"` }
A component value for a subscription.
func (SubscriptionNewParamsComponentValue) MarshalJSON ¶
func (r SubscriptionNewParamsComponentValue) MarshalJSON() (data []byte, err error)
type SubscriptionNewParamsFrequency ¶
type SubscriptionNewParamsFrequency string
How often the subscription is renewed automatically.
const ( SubscriptionNewParamsFrequencyWeekly SubscriptionNewParamsFrequency = "weekly" SubscriptionNewParamsFrequencyMonthly SubscriptionNewParamsFrequency = "monthly" SubscriptionNewParamsFrequencyQuarterly SubscriptionNewParamsFrequency = "quarterly" SubscriptionNewParamsFrequencyYearly SubscriptionNewParamsFrequency = "yearly" )
type SubscriptionNewParamsRatePlan ¶
type SubscriptionNewParamsRatePlan struct { // The ID of the rate plan. ID param.Field[interface{}] `json:"id"` // The currency applied to the rate plan subscription. Currency param.Field[string] `json:"currency"` // Whether this rate plan is managed externally from Cloudflare. ExternallyManaged param.Field[bool] `json:"externally_managed"` // Whether a rate plan is enterprise-based (or newly adopted term contract). IsContract param.Field[bool] `json:"is_contract"` // The full name of the rate plan. PublicName param.Field[string] `json:"public_name"` // The scope that this rate plan applies to. Scope param.Field[string] `json:"scope"` // The list of sets this rate plan applies to. Sets param.Field[[]string] `json:"sets"` }
The rate plan applied to the subscription.
func (SubscriptionNewParamsRatePlan) MarshalJSON ¶
func (r SubscriptionNewParamsRatePlan) MarshalJSON() (data []byte, err error)
type SubscriptionNewParamsZone ¶
type SubscriptionNewParamsZone struct { }
A simple zone object. May have null properties if not a zone subscription.
func (SubscriptionNewParamsZone) MarshalJSON ¶
func (r SubscriptionNewParamsZone) MarshalJSON() (data []byte, err error)
type SubscriptionNewResponse ¶
type SubscriptionNewResponse interface {
ImplementsSubscriptionsSubscriptionNewResponse()
}
Union satisfied by subscriptions.SubscriptionNewResponseUnknown or shared.UnionString.
type SubscriptionNewResponseEnvelope ¶
type SubscriptionNewResponseEnvelope struct { Errors []SubscriptionNewResponseEnvelopeErrors `json:"errors,required"` Messages []SubscriptionNewResponseEnvelopeMessages `json:"messages,required"` Result SubscriptionNewResponse `json:"result,required"` // Whether the API call was successful Success SubscriptionNewResponseEnvelopeSuccess `json:"success,required"` JSON subscriptionNewResponseEnvelopeJSON `json:"-"` }
func (*SubscriptionNewResponseEnvelope) UnmarshalJSON ¶
func (r *SubscriptionNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type SubscriptionNewResponseEnvelopeErrors ¶
type SubscriptionNewResponseEnvelopeErrors struct { Code int64 `json:"code,required"` Message string `json:"message,required"` JSON subscriptionNewResponseEnvelopeErrorsJSON `json:"-"` }
func (*SubscriptionNewResponseEnvelopeErrors) UnmarshalJSON ¶
func (r *SubscriptionNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type SubscriptionNewResponseEnvelopeMessages ¶
type SubscriptionNewResponseEnvelopeMessages struct { Code int64 `json:"code,required"` Message string `json:"message,required"` JSON subscriptionNewResponseEnvelopeMessagesJSON `json:"-"` }
func (*SubscriptionNewResponseEnvelopeMessages) UnmarshalJSON ¶
func (r *SubscriptionNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type SubscriptionNewResponseEnvelopeSuccess ¶
type SubscriptionNewResponseEnvelopeSuccess bool
Whether the API call was successful
const (
SubscriptionNewResponseEnvelopeSuccessTrue SubscriptionNewResponseEnvelopeSuccess = true
)
type SubscriptionService ¶
type SubscriptionService struct {
Options []option.RequestOption
}
SubscriptionService contains methods and other services that help with interacting with the cloudflare API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewSubscriptionService method instead.
func NewSubscriptionService ¶
func NewSubscriptionService(opts ...option.RequestOption) (r *SubscriptionService)
NewSubscriptionService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*SubscriptionService) Delete ¶
func (r *SubscriptionService) Delete(ctx context.Context, accountIdentifier string, subscriptionIdentifier string, opts ...option.RequestOption) (res *SubscriptionDeleteResponse, err error)
Deletes an account's subscription.
func (*SubscriptionService) Get ¶
func (r *SubscriptionService) Get(ctx context.Context, identifier string, opts ...option.RequestOption) (res *SubscriptionGetResponse, err error)
Lists zone subscription details.
func (*SubscriptionService) List ¶
func (r *SubscriptionService) List(ctx context.Context, accountIdentifier string, opts ...option.RequestOption) (res *[]SubscriptionListResponse, err error)
Lists all of an account's subscriptions.
func (*SubscriptionService) New ¶
func (r *SubscriptionService) New(ctx context.Context, identifier string, body SubscriptionNewParams, opts ...option.RequestOption) (res *SubscriptionNewResponse, err error)
Create a zone subscription, either plan or add-ons.
func (*SubscriptionService) Update ¶
func (r *SubscriptionService) Update(ctx context.Context, accountIdentifier string, subscriptionIdentifier string, body SubscriptionUpdateParams, opts ...option.RequestOption) (res *SubscriptionUpdateResponse, err error)
Updates an account subscription.
type SubscriptionUpdateParams ¶
type SubscriptionUpdateParams struct { App param.Field[SubscriptionUpdateParamsApp] `json:"app"` // The list of add-ons subscribed to. ComponentValues param.Field[[]SubscriptionUpdateParamsComponentValue] `json:"component_values"` // How often the subscription is renewed automatically. Frequency param.Field[SubscriptionUpdateParamsFrequency] `json:"frequency"` // The rate plan applied to the subscription. RatePlan param.Field[SubscriptionUpdateParamsRatePlan] `json:"rate_plan"` // A simple zone object. May have null properties if not a zone subscription. Zone param.Field[SubscriptionUpdateParamsZone] `json:"zone"` }
func (SubscriptionUpdateParams) MarshalJSON ¶
func (r SubscriptionUpdateParams) MarshalJSON() (data []byte, err error)
type SubscriptionUpdateParamsApp ¶
type SubscriptionUpdateParamsApp struct { // app install id. InstallID param.Field[string] `json:"install_id"` }
func (SubscriptionUpdateParamsApp) MarshalJSON ¶
func (r SubscriptionUpdateParamsApp) MarshalJSON() (data []byte, err error)
type SubscriptionUpdateParamsComponentValue ¶
type SubscriptionUpdateParamsComponentValue struct { // The default amount assigned. Default param.Field[float64] `json:"default"` // The name of the component value. Name param.Field[string] `json:"name"` // The unit price for the component value. Price param.Field[float64] `json:"price"` // The amount of the component value assigned. Value param.Field[float64] `json:"value"` }
A component value for a subscription.
func (SubscriptionUpdateParamsComponentValue) MarshalJSON ¶
func (r SubscriptionUpdateParamsComponentValue) MarshalJSON() (data []byte, err error)
type SubscriptionUpdateParamsFrequency ¶
type SubscriptionUpdateParamsFrequency string
How often the subscription is renewed automatically.
const ( SubscriptionUpdateParamsFrequencyWeekly SubscriptionUpdateParamsFrequency = "weekly" SubscriptionUpdateParamsFrequencyMonthly SubscriptionUpdateParamsFrequency = "monthly" SubscriptionUpdateParamsFrequencyQuarterly SubscriptionUpdateParamsFrequency = "quarterly" SubscriptionUpdateParamsFrequencyYearly SubscriptionUpdateParamsFrequency = "yearly" )
type SubscriptionUpdateParamsRatePlan ¶
type SubscriptionUpdateParamsRatePlan struct { // The ID of the rate plan. ID param.Field[interface{}] `json:"id"` // The currency applied to the rate plan subscription. Currency param.Field[string] `json:"currency"` // Whether this rate plan is managed externally from Cloudflare. ExternallyManaged param.Field[bool] `json:"externally_managed"` // Whether a rate plan is enterprise-based (or newly adopted term contract). IsContract param.Field[bool] `json:"is_contract"` // The full name of the rate plan. PublicName param.Field[string] `json:"public_name"` // The scope that this rate plan applies to. Scope param.Field[string] `json:"scope"` // The list of sets this rate plan applies to. Sets param.Field[[]string] `json:"sets"` }
The rate plan applied to the subscription.
func (SubscriptionUpdateParamsRatePlan) MarshalJSON ¶
func (r SubscriptionUpdateParamsRatePlan) MarshalJSON() (data []byte, err error)
type SubscriptionUpdateParamsZone ¶
type SubscriptionUpdateParamsZone struct { }
A simple zone object. May have null properties if not a zone subscription.
func (SubscriptionUpdateParamsZone) MarshalJSON ¶
func (r SubscriptionUpdateParamsZone) MarshalJSON() (data []byte, err error)
type SubscriptionUpdateResponse ¶
type SubscriptionUpdateResponse interface {
ImplementsSubscriptionsSubscriptionUpdateResponse()
}
Union satisfied by subscriptions.SubscriptionUpdateResponseUnknown or shared.UnionString.
type SubscriptionUpdateResponseEnvelope ¶
type SubscriptionUpdateResponseEnvelope struct { Errors []SubscriptionUpdateResponseEnvelopeErrors `json:"errors,required"` Messages []SubscriptionUpdateResponseEnvelopeMessages `json:"messages,required"` Result SubscriptionUpdateResponse `json:"result,required"` // Whether the API call was successful Success SubscriptionUpdateResponseEnvelopeSuccess `json:"success,required"` JSON subscriptionUpdateResponseEnvelopeJSON `json:"-"` }
func (*SubscriptionUpdateResponseEnvelope) UnmarshalJSON ¶
func (r *SubscriptionUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type SubscriptionUpdateResponseEnvelopeErrors ¶
type SubscriptionUpdateResponseEnvelopeErrors struct { Code int64 `json:"code,required"` Message string `json:"message,required"` JSON subscriptionUpdateResponseEnvelopeErrorsJSON `json:"-"` }
func (*SubscriptionUpdateResponseEnvelopeErrors) UnmarshalJSON ¶
func (r *SubscriptionUpdateResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type SubscriptionUpdateResponseEnvelopeMessages ¶
type SubscriptionUpdateResponseEnvelopeMessages struct { Code int64 `json:"code,required"` Message string `json:"message,required"` JSON subscriptionUpdateResponseEnvelopeMessagesJSON `json:"-"` }
func (*SubscriptionUpdateResponseEnvelopeMessages) UnmarshalJSON ¶
func (r *SubscriptionUpdateResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type SubscriptionUpdateResponseEnvelopeSuccess ¶
type SubscriptionUpdateResponseEnvelopeSuccess bool
Whether the API call was successful
const (
SubscriptionUpdateResponseEnvelopeSuccessTrue SubscriptionUpdateResponseEnvelopeSuccess = true
)