billing

Documentation

Index

• Constants
• type ASN
• type ASNParam
• type AuditLog
• type AuditLogAction
• type AuditLogActor
• type AuditLogActorType
• type AuditLogOwner
• type AuditLogResource
• type BillingService
  • func NewBillingService(opts ...option.RequestOption) (r *BillingService)
• type CertificateCA
• type CertificateRequestType
• type CloudflareTunnel
• type CloudflareTunnelConnection
• type CloudflareTunnelStatus
• type CloudflareTunnelTunType
• type Error
• type ErrorData
• type MemberParam
• type MemberRoleParam
• type MemberRolesPermissionsParam
• type MemberStatus
• type MemberUserParam
• type Permission
• type PermissionGrant
• type PermissionGrantParam
• type ProfileGetParams
• type ProfileGetResponse
  • func (r *ProfileGetResponse) UnmarshalJSON(data []byte) (err error)
• type ProfileGetResponseEnvelope
  • func (r *ProfileGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
• type ProfileGetResponseEnvelopeSuccess
  • func (r ProfileGetResponseEnvelopeSuccess) IsKnown() bool
• type ProfileService
  • func NewProfileService(opts ...option.RequestOption) (r *ProfileService)
  • func (r *ProfileService) Get(ctx context.Context, query ProfileGetParams, opts ...option.RequestOption) (res *ProfileGetResponse, err error)
• type RatePlan
• type RatePlanParam
• type ResponseInfo
• type Role
• type SortDirection
• type Subscription
• type SubscriptionFrequency
• type SubscriptionParam
• type SubscriptionState

Constants

const AuditLogActorTypeAdmin = shared.AuditLogActorTypeAdmin

This is an alias to an internal value.

const AuditLogActorTypeCloudflare = shared.AuditLogActorTypeCloudflare

This is an alias to an internal value.

const AuditLogActorTypeUser = shared.AuditLogActorTypeUser

This is an alias to an internal value.

const CertificateCADigicert = shared.CertificateCADigicert

This is an alias to an internal value.

const CertificateCAGoogle = shared.CertificateCAGoogle

This is an alias to an internal value.

const CertificateCALetsEncrypt = shared.CertificateCALetsEncrypt

This is an alias to an internal value.

const CertificateCASSLCom = shared.CertificateCASSLCom

This is an alias to an internal value.

const CertificateRequestTypeKeylessCertificate = shared.CertificateRequestTypeKeylessCertificate

This is an alias to an internal value.

const CertificateRequestTypeOriginECC = shared.CertificateRequestTypeOriginECC

This is an alias to an internal value.

const CertificateRequestTypeOriginRSA = shared.CertificateRequestTypeOriginRSA

This is an alias to an internal value.

const CloudflareTunnelStatusDegraded = shared.CloudflareTunnelStatusDegraded

This is an alias to an internal value.

const CloudflareTunnelStatusDown = shared.CloudflareTunnelStatusDown

This is an alias to an internal value.

const CloudflareTunnelStatusHealthy = shared.CloudflareTunnelStatusHealthy

This is an alias to an internal value.

const CloudflareTunnelStatusInactive = shared.CloudflareTunnelStatusInactive

This is an alias to an internal value.

const CloudflareTunnelTunTypeCNI = shared.CloudflareTunnelTunTypeCNI

This is an alias to an internal value.

const CloudflareTunnelTunTypeCfdTunnel = shared.CloudflareTunnelTunTypeCfdTunnel

This is an alias to an internal value.

const CloudflareTunnelTunTypeGRE = shared.CloudflareTunnelTunTypeGRE

This is an alias to an internal value.

const CloudflareTunnelTunTypeIPSec = shared.CloudflareTunnelTunTypeIPSec

This is an alias to an internal value.

const CloudflareTunnelTunTypeWARPConnector = shared.CloudflareTunnelTunTypeWARPConnector

This is an alias to an internal value.

const MemberStatusAccepted = shared.MemberStatusAccepted

This is an alias to an internal value.

const MemberStatusPending = shared.MemberStatusPending

This is an alias to an internal value.

const SortDirectionAsc = shared.SortDirectionAsc

This is an alias to an internal value.

const SortDirectionDesc = shared.SortDirectionDesc

This is an alias to an internal value.

const SubscriptionFrequencyMonthly = shared.SubscriptionFrequencyMonthly

This is an alias to an internal value.

const SubscriptionFrequencyQuarterly = shared.SubscriptionFrequencyQuarterly

This is an alias to an internal value.

const SubscriptionFrequencyWeekly = shared.SubscriptionFrequencyWeekly

This is an alias to an internal value.

const SubscriptionFrequencyYearly = shared.SubscriptionFrequencyYearly

This is an alias to an internal value.

const SubscriptionStateAwaitingPayment = shared.SubscriptionStateAwaitingPayment

This is an alias to an internal value.

const SubscriptionStateCancelled = shared.SubscriptionStateCancelled

This is an alias to an internal value.

const SubscriptionStateExpired = shared.SubscriptionStateExpired

This is an alias to an internal value.

const SubscriptionStateFailed = shared.SubscriptionStateFailed

This is an alias to an internal value.

const SubscriptionStatePaid = shared.SubscriptionStatePaid

This is an alias to an internal value.

const SubscriptionStateProvisioned = shared.SubscriptionStateProvisioned

This is an alias to an internal value.

const SubscriptionStateTrial = shared.SubscriptionStateTrial

This is an alias to an internal value.

Types

type ASN

type ASN = shared.ASN

This is an alias to an internal type.

type ASNParam

type ASNParam = shared.ASNParam

This is an alias to an internal type.

type AuditLog

type AuditLog = shared.AuditLog

This is an alias to an internal type.

type AuditLogAction

type AuditLogAction = shared.AuditLogAction

This is an alias to an internal type.

type AuditLogActor

type AuditLogActor = shared.AuditLogActor

This is an alias to an internal type.

type AuditLogActorType

type AuditLogActorType = shared.AuditLogActorType

The type of actor, whether a User, Cloudflare Admin, or an Automated System.

This is an alias to an internal type.

type AuditLogOwner

type AuditLogOwner = shared.AuditLogOwner

This is an alias to an internal type.

type AuditLogResource

type AuditLogResource = shared.AuditLogResource

This is an alias to an internal type.

type BillingService

type BillingService struct {
	Options  []option.RequestOption
	Profiles *ProfileService
}

BillingService 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 NewBillingService method instead.

func NewBillingService

func NewBillingService(opts ...option.RequestOption) (r *BillingService)

NewBillingService 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.

type CertificateCA

type CertificateCA = shared.CertificateCA

The Certificate Authority that will issue the certificate

This is an alias to an internal type.

type CertificateRequestType

type CertificateRequestType = shared.CertificateRequestType

Signature type desired on certificate ("origin-rsa" (rsa), "origin-ecc" (ecdsa), or "keyless-certificate" (for Keyless SSL servers).

This is an alias to an internal type.

type CloudflareTunnel

type CloudflareTunnel = shared.CloudflareTunnel

A Cloudflare Tunnel that connects your origin to Cloudflare's edge.

This is an alias to an internal type.

type CloudflareTunnelConnection

type CloudflareTunnelConnection = shared.CloudflareTunnelConnection

This is an alias to an internal type.

type CloudflareTunnelStatus

type CloudflareTunnelStatus = shared.CloudflareTunnelStatus

The status of the tunnel. Valid values are `inactive` (tunnel has never been run), `degraded` (tunnel is active and able to serve traffic but in an unhealthy state), `healthy` (tunnel is active and able to serve traffic), or `down` (tunnel can not serve traffic as it has no connections to the Cloudflare Edge).

This is an alias to an internal type.

type CloudflareTunnelTunType

type CloudflareTunnelTunType = shared.CloudflareTunnelTunType

The type of tunnel.

This is an alias to an internal type.

type Error

type Error = apierror.Error

type ErrorData

type ErrorData = shared.ErrorData

This is an alias to an internal type.

type MemberParam

type MemberParam = shared.MemberParam

This is an alias to an internal type.

type MemberRoleParam

type MemberRoleParam = shared.MemberRoleParam

This is an alias to an internal type.

type MemberRolesPermissionsParam

type MemberRolesPermissionsParam = shared.MemberRolesPermissionsParam

This is an alias to an internal type.

type MemberStatus

type MemberStatus = shared.MemberStatus

A member's status in the account.

This is an alias to an internal type.

type MemberUserParam

type MemberUserParam = shared.MemberUserParam

Details of the user associated to the membership.

This is an alias to an internal type.

type Permission

type Permission = shared.Permission

This is an alias to an internal type.

type PermissionGrant

type PermissionGrant = shared.PermissionGrant

This is an alias to an internal type.

type PermissionGrantParam

type PermissionGrantParam = shared.PermissionGrantParam

This is an alias to an internal type.

type ProfileGetParams

type ProfileGetParams struct {
	// Identifier
	AccountID param.Field[string] `path:"account_id,required"`
}

type ProfileGetResponse

type ProfileGetResponse struct {
	// Billing item identifier tag.
	ID                     string                 `json:"id"`
	AccountType            string                 `json:"account_type"`
	Address                string                 `json:"address"`
	Address2               string                 `json:"address2"`
	Balance                string                 `json:"balance"`
	CardExpiryMonth        int64                  `json:"card_expiry_month"`
	CardExpiryYear         int64                  `json:"card_expiry_year"`
	CardNumber             string                 `json:"card_number"`
	City                   string                 `json:"city"`
	Company                string                 `json:"company"`
	Country                string                 `json:"country"`
	CreatedOn              time.Time              `json:"created_on" format:"date-time"`
	DeviceData             string                 `json:"device_data"`
	EditedOn               time.Time              `json:"edited_on" format:"date-time"`
	EnterpriseBillingEmail string                 `json:"enterprise_billing_email"`
	EnterprisePrimaryEmail string                 `json:"enterprise_primary_email"`
	FirstName              string                 `json:"first_name"`
	IsPartner              bool                   `json:"is_partner"`
	LastName               string                 `json:"last_name"`
	NextBillDate           time.Time              `json:"next_bill_date" format:"date-time"`
	PaymentAddress         string                 `json:"payment_address"`
	PaymentAddress2        string                 `json:"payment_address2"`
	PaymentCity            string                 `json:"payment_city"`
	PaymentCountry         string                 `json:"payment_country"`
	PaymentEmail           string                 `json:"payment_email"`
	PaymentFirstName       string                 `json:"payment_first_name"`
	PaymentGateway         string                 `json:"payment_gateway"`
	PaymentLastName        string                 `json:"payment_last_name"`
	PaymentNonce           string                 `json:"payment_nonce"`
	PaymentState           string                 `json:"payment_state"`
	PaymentZipcode         string                 `json:"payment_zipcode"`
	PrimaryEmail           string                 `json:"primary_email"`
	State                  string                 `json:"state"`
	TaxIDType              string                 `json:"tax_id_type"`
	Telephone              string                 `json:"telephone"`
	UseLegacy              bool                   `json:"use_legacy"`
	ValidationCode         string                 `json:"validation_code"`
	Vat                    string                 `json:"vat"`
	Zipcode                string                 `json:"zipcode"`
	JSON                   profileGetResponseJSON `json:"-"`
}

func (*ProfileGetResponse) UnmarshalJSON

func (r *ProfileGetResponse) UnmarshalJSON(data []byte) (err error)

type ProfileGetResponseEnvelope

type ProfileGetResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	Result   ProfileGetResponse    `json:"result,required"`
	// Whether the API call was successful
	Success ProfileGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    profileGetResponseEnvelopeJSON    `json:"-"`
}

func (*ProfileGetResponseEnvelope) UnmarshalJSON

func (r *ProfileGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type ProfileGetResponseEnvelopeSuccess

type ProfileGetResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	ProfileGetResponseEnvelopeSuccessTrue ProfileGetResponseEnvelopeSuccess = true
)

func (ProfileGetResponseEnvelopeSuccess) IsKnown

func (r ProfileGetResponseEnvelopeSuccess) IsKnown() bool

type ProfileService

type ProfileService struct {
	Options []option.RequestOption
}

ProfileService 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 NewProfileService method instead.

func NewProfileService

func NewProfileService(opts ...option.RequestOption) (r *ProfileService)

NewProfileService 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 (*ProfileService) Get

func (r *ProfileService) Get(ctx context.Context, query ProfileGetParams, opts ...option.RequestOption) (res *ProfileGetResponse, err error)

Gets the current billing profile for the account.

type RatePlan

type RatePlan = shared.RatePlan

The rate plan applied to the subscription.

This is an alias to an internal type.

type RatePlanParam

type RatePlanParam = shared.RatePlanParam

The rate plan applied to the subscription.

This is an alias to an internal type.

type ResponseInfo

type ResponseInfo = shared.ResponseInfo

This is an alias to an internal type.

type Role

type Role = shared.Role

This is an alias to an internal type.

type SortDirection

type SortDirection = shared.SortDirection

Direction to order DNS records in.

This is an alias to an internal type.

type Subscription

type Subscription = shared.Subscription

This is an alias to an internal type.

type SubscriptionFrequency

type SubscriptionFrequency = shared.SubscriptionFrequency

How often the subscription is renewed automatically.

This is an alias to an internal type.

type SubscriptionParam

type SubscriptionParam = shared.SubscriptionParam

This is an alias to an internal type.

type SubscriptionState

type SubscriptionState = shared.SubscriptionState

The state that the subscription is in.

This is an alias to an internal type.