Documentation
¶
Index ¶
- type BillSubsAPIAvailableRatePlan
- type BillSubsAPIAvailableRatePlanFrequency
- type Error
- type PlanGetResponseEnvelope
- type PlanGetResponseEnvelopeErrors
- type PlanGetResponseEnvelopeMessages
- type PlanGetResponseEnvelopeSuccess
- type PlanListResponseEnvelope
- type PlanListResponseEnvelopeErrors
- type PlanListResponseEnvelopeMessages
- type PlanListResponseEnvelopeResultInfo
- type PlanListResponseEnvelopeSuccess
- type PlanService
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type BillSubsAPIAvailableRatePlan ¶
type BillSubsAPIAvailableRatePlan struct {
// Identifier
ID string `json:"id"`
// Indicates whether you can subscribe to this plan.
CanSubscribe bool `json:"can_subscribe"`
// The monetary unit in which pricing information is displayed.
Currency string `json:"currency"`
// Indicates whether this plan is managed externally.
ExternallyManaged bool `json:"externally_managed"`
// The frequency at which you will be billed for this plan.
Frequency BillSubsAPIAvailableRatePlanFrequency `json:"frequency"`
// Indicates whether you are currently subscribed to this plan.
IsSubscribed bool `json:"is_subscribed"`
// Indicates whether this plan has a legacy discount applied.
LegacyDiscount bool `json:"legacy_discount"`
// The legacy identifier for this rate plan, if any.
LegacyID string `json:"legacy_id"`
// The plan name.
Name string `json:"name"`
// The amount you will be billed for this plan.
Price float64 `json:"price"`
JSON billSubsAPIAvailableRatePlanJSON `json:"-"`
}
func (*BillSubsAPIAvailableRatePlan) UnmarshalJSON ¶
func (r *BillSubsAPIAvailableRatePlan) UnmarshalJSON(data []byte) (err error)
type BillSubsAPIAvailableRatePlanFrequency ¶
type BillSubsAPIAvailableRatePlanFrequency string
The frequency at which you will be billed for this plan.
const ( BillSubsAPIAvailableRatePlanFrequencyWeekly BillSubsAPIAvailableRatePlanFrequency = "weekly" BillSubsAPIAvailableRatePlanFrequencyMonthly BillSubsAPIAvailableRatePlanFrequency = "monthly" BillSubsAPIAvailableRatePlanFrequencyQuarterly BillSubsAPIAvailableRatePlanFrequency = "quarterly" BillSubsAPIAvailableRatePlanFrequencyYearly BillSubsAPIAvailableRatePlanFrequency = "yearly" )
func (BillSubsAPIAvailableRatePlanFrequency) IsKnown ¶
func (r BillSubsAPIAvailableRatePlanFrequency) IsKnown() bool
type PlanGetResponseEnvelope ¶
type PlanGetResponseEnvelope struct {
Errors []PlanGetResponseEnvelopeErrors `json:"errors,required"`
Messages []PlanGetResponseEnvelopeMessages `json:"messages,required"`
Result BillSubsAPIAvailableRatePlan `json:"result,required"`
// Whether the API call was successful
Success PlanGetResponseEnvelopeSuccess `json:"success,required"`
JSON planGetResponseEnvelopeJSON `json:"-"`
}
func (*PlanGetResponseEnvelope) UnmarshalJSON ¶
func (r *PlanGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type PlanGetResponseEnvelopeErrors ¶
type PlanGetResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
JSON planGetResponseEnvelopeErrorsJSON `json:"-"`
}
func (*PlanGetResponseEnvelopeErrors) UnmarshalJSON ¶
func (r *PlanGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type PlanGetResponseEnvelopeMessages ¶
type PlanGetResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
JSON planGetResponseEnvelopeMessagesJSON `json:"-"`
}
func (*PlanGetResponseEnvelopeMessages) UnmarshalJSON ¶
func (r *PlanGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type PlanGetResponseEnvelopeSuccess ¶
type PlanGetResponseEnvelopeSuccess bool
Whether the API call was successful
const (
PlanGetResponseEnvelopeSuccessTrue PlanGetResponseEnvelopeSuccess = true
)
func (PlanGetResponseEnvelopeSuccess) IsKnown ¶
func (r PlanGetResponseEnvelopeSuccess) IsKnown() bool
type PlanListResponseEnvelope ¶
type PlanListResponseEnvelope struct {
Errors []PlanListResponseEnvelopeErrors `json:"errors,required"`
Messages []PlanListResponseEnvelopeMessages `json:"messages,required"`
Result []BillSubsAPIAvailableRatePlan `json:"result,required,nullable"`
// Whether the API call was successful
Success PlanListResponseEnvelopeSuccess `json:"success,required"`
ResultInfo PlanListResponseEnvelopeResultInfo `json:"result_info"`
JSON planListResponseEnvelopeJSON `json:"-"`
}
func (*PlanListResponseEnvelope) UnmarshalJSON ¶
func (r *PlanListResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type PlanListResponseEnvelopeErrors ¶
type PlanListResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
JSON planListResponseEnvelopeErrorsJSON `json:"-"`
}
func (*PlanListResponseEnvelopeErrors) UnmarshalJSON ¶
func (r *PlanListResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type PlanListResponseEnvelopeMessages ¶
type PlanListResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
JSON planListResponseEnvelopeMessagesJSON `json:"-"`
}
func (*PlanListResponseEnvelopeMessages) UnmarshalJSON ¶
func (r *PlanListResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type PlanListResponseEnvelopeResultInfo ¶
type PlanListResponseEnvelopeResultInfo 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 planListResponseEnvelopeResultInfoJSON `json:"-"`
}
func (*PlanListResponseEnvelopeResultInfo) UnmarshalJSON ¶
func (r *PlanListResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error)
type PlanListResponseEnvelopeSuccess ¶
type PlanListResponseEnvelopeSuccess bool
Whether the API call was successful
const (
PlanListResponseEnvelopeSuccessTrue PlanListResponseEnvelopeSuccess = true
)
func (PlanListResponseEnvelopeSuccess) IsKnown ¶
func (r PlanListResponseEnvelopeSuccess) IsKnown() bool
type PlanService ¶
type PlanService struct {
Options []option.RequestOption
}
PlanService 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 NewPlanService method instead.
func NewPlanService ¶
func NewPlanService(opts ...option.RequestOption) (r *PlanService)
NewPlanService 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 (*PlanService) Get ¶
func (r *PlanService) Get(ctx context.Context, zoneIdentifier string, planIdentifier string, opts ...option.RequestOption) (res *BillSubsAPIAvailableRatePlan, err error)
Details of the available plan that the zone can subscribe to.
func (*PlanService) List ¶
func (r *PlanService) List(ctx context.Context, zoneIdentifier string, opts ...option.RequestOption) (res *[]BillSubsAPIAvailableRatePlan, err error)
Lists available plans the zone can subscribe to.