package io.ultimatebackend.srv.billing

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc CreateCustomer (CreateCustomerRequest, CreateCustomerResponse)

  billing.proto:8

  message CreateCustomerRequest

  billing.proto:393

  • string name = 1

  • string email = 2

  • string number = 3

  • string currency = 4

  message CreateCustomerResponse

  billing.proto:400

  • optional Customer customer = 1

• rpc DeleteCustomer (DeleteCustomerRequest, DeleteCustomerResponse)

  billing.proto:9

  message DeleteCustomerRequest

  billing.proto:404

  • string id = 1

  message DeleteCustomerResponse

  billing.proto:408

  • optional Customer customer = 1

• rpc ReadCustomer (ReadCustomerRequest, ReadCustomerResponse)

  billing.proto:10

  message ReadCustomerRequest

  billing.proto:412

  • string id = 1

  message ReadCustomerResponse

  billing.proto:416

  • optional Customer customer = 1

• rpc CreatePlan (CreatePlanRequest, CreatePlanResponse)

  billing.proto:12

  message CreatePlanRequest

  billing.proto:239

  • string name = 1

  • string description = 2

  • repeated CreatePriceRequest prices = 3

  • repeated Feature features = 4

  • bool active = 8

  • bool free = 9

  message CreatePlanResponse

  billing.proto:248

  • optional Plan plan = 1

• rpc ReadPlan (ReadPlanRequest, ReadPlanResponse)

  billing.proto:13

  message ReadPlanRequest

  billing.proto:252

  • string id = 1

  message ReadPlanResponse

  billing.proto:256

  • optional Plan plan = 1

• rpc FindPlans (FindPlansRequest, FindPlansResponse)

  billing.proto:14

  message FindPlansRequest

  billing.proto:260

  (message has no fields)

  message FindPlansResponse

  billing.proto:262

  • repeated Plan plans = 1

• rpc ReadStripePlan (ReadStripePlanRequest, ReadStripePlanResponse)

  billing.proto:15

  message ReadStripePlanRequest

  billing.proto:266

  • string id = 1

  message ReadStripePlanResponse

  billing.proto:270

  • optional StripePlan plan = 1

• rpc FindStripePlans (FindStripePlansRequest, FindStripePlansResponse)

  billing.proto:16

  message FindStripePlansRequest

  billing.proto:274

  • string productId = 1

  message FindStripePlansResponse

  billing.proto:278

  • repeated StripePlan plans = 1

• rpc CreateCard (CreateCardRequest, CreateCardResponse)

  billing.proto:18

  message CreateCardRequest

  billing.proto:347

  Cards

  • string name = 1

  • string cvc = 2

  • string number = 3

  • string currency = 4

  • string expMonth = 8

  • string expYear = 9

  • optional Address address = 10

  message CreateCardResponse

  billing.proto:357

  • optional Card card = 1

• rpc DeleteCard (DeleteCardRequest, DeleteCardResponse)

  billing.proto:19

  message DeleteCardRequest

  billing.proto:369

  • string id = 1

  message DeleteCardResponse

  billing.proto:373

  • optional Card card = 1

• rpc SetDefaultCard (SetDefaultCardRequest, SetDefaultCardResponse)

  billing.proto:20

  message SetDefaultCardRequest

  billing.proto:361

  • string id = 1

  message SetDefaultCardResponse

  billing.proto:365

  • optional Card card = 1

• rpc ReadCard (ReadCardRequest, ReadCardResponse)

  billing.proto:21

  message ReadCardRequest

  billing.proto:377

  • string id = 1

  message ReadCardResponse

  billing.proto:381

  • optional Card card = 1

• rpc FindCards (FindCardsRequest, FindCardsResponse)

  billing.proto:22

  message FindCardsRequest

  billing.proto:385

  (message has no fields)

  message FindCardsResponse

  billing.proto:387

  • repeated Card cards = 1

• rpc CreateSubscription (CreateSubscriptionRequest, CreateSubscriptionResponse)

  billing.proto:24

  message CreateSubscriptionRequest

  billing.proto:297

  Subscription

  • string customerId = 1

  • string tenantId = 2

  • string planId = 3

  • string couponId = 4

  • string cardId = 5

  message CreateSubscriptionResponse

  billing.proto:305

  • optional TenantSubscription subscription = 1

• rpc CancelSubscription (CancelSubscriptionRequest, CancelSubscriptionResponse)

  billing.proto:25

  message CancelSubscriptionRequest

  billing.proto:320

  • string customerId = 1

  • string tenantId = 2

  message CancelSubscriptionResponse

  billing.proto:325

  • optional TenantSubscription subscription = 1

• rpc ChangeSubscription (ChangeSubscriptionRequest, ChangeSubscriptionResponse)

  billing.proto:26

  message ChangeSubscriptionRequest

  billing.proto:309

  • string customerId = 1

  • string tenantId = 2

  • string planId = 3

  • string couponId = 4

  message ChangeSubscriptionResponse

  billing.proto:316

  • optional TenantSubscription subscription = 1

• rpc ReadSubscription (ReadSubscriptionRequest, ReadSubscriptionResponse)

  billing.proto:27

  message ReadSubscriptionRequest

  billing.proto:329

  • string id = 1

  • string tenantId = 2

  message ReadSubscriptionResponse

  billing.proto:334

  • optional TenantSubscription subscription = 1

• rpc FindSubscriptions (FindSubscriptionsRequest, FindSubscriptionsResponse)

  billing.proto:28

  message FindSubscriptionsRequest

  billing.proto:338

  • string tenantId = 1

  message FindSubscriptionsResponse

  billing.proto:342

  • repeated TenantSubscription subscriptions = 1

• rpc ReadInvoice (ReadInvoiceRequest, ReadInvoiceResponse)

  billing.proto:30

  message ReadInvoiceRequest

  billing.proto:282

  • string id = 1

  message ReadInvoiceResponse

  billing.proto:286

  • optional Invoice invoice = 1

• rpc FindInvoices (FindInvoicesRequest, FindInvoicesResponse)

  billing.proto:31

  message FindInvoicesRequest

  billing.proto:290

  (message has no fields)

  message FindInvoicesResponse

  billing.proto:292

  • repeated Invoice invoices = 1

Used in: Card, CreateCardRequest

• string id = 1

• string country = 2

• string state = 3

• string city = 4

• string postalCode = 5

• string line = 6

• string line2 = 7

Used in: CreateCardResponse, DeleteCardResponse, FindCardsResponse, ReadCardResponse, SetDefaultCardResponse

• string id = 1

• string name = 2

• string cvc = 3

• string number = 4

• string brand = 5

• string currency = 6

• optional Address address = 7

• uint32 expMonth = 8

• uint32 expYear = 9

• string lastFourDigit = 10

• bool isDefault = 11

Used in: CreatePlanRequest

• float price = 1

• string currency = 2

• string id = 3

• string nickname = 4

• int32 trialDays = 5

• int32 intervalCount = 6

• string interval = 7

Used in: CreateCustomerResponse, DeleteCustomerResponse, ReadCustomerResponse

• string id = 1

  @inject_tag: bson:"_id,omitempty"

• string email = 4

  @inject_tag: bson:"email,omitempty"

• string name = 5

  @inject_tag: bson:"name,omitempty"

• string id = 1

  unique id

• int32 timestamp = 2

  unix timestamp

• string message = 3

  message

• string topic = 4

  message

Used in: CreatePlanRequest, Plan

• string name = 1

  @inject_tag: bson:"name,omitempty"

• string normalizedName = 2

  @inject_tag: bson:"normalizedName,omitempty"

• string description = 3

  @inject_tag: bson:"description,omitempty"

• int32 min = 4

  @inject_tag: bson:"min,omitempty"

• int32 max = 5

  @inject_tag: bson:"max,omitempty"

• bool active = 6

  @inject_tag: bson:"active,omitempty"

• bool full = 7

  @inject_tag: bson:"full,omitempty"

• string unit = 8

  @inject_tag: bson:"full,omitempty"

Used in: FindInvoicesResponse, ReadInvoiceResponse

• string id = 1

  @inject_tag: bson:"id,omitempty"

• string accountCountry = 2

• string accountName = 3

• float amountDue = 4

• float amountPaid = 5

• float amountRemaining = 6

• string billingReason = 7

• string currency = 8

• string customerEmail = 9

• string customerName = 10

• string description = 11

• string dueDate = 12

• float endingBalance = 13

• string hostedInvoiceUrl = 14

• string invoicePdf = 15

• string number = 16

• bool paid = 17

• string receiptNumber = 18

• float startingBalance = 19

• string statementDescriptor = 20

• string status = 21

• int32 subtotal = 22

• float tax = 23

• float taxPercent = 24

• float total = 25

• string createdAt = 26

  @inject_tag: bson:"createdAt,omitempty"

• string updatedAt = 27

  @inject_tag: bson:"updatedAt,omitempty"

• DRAFT = 0

• OPEN = 1

• PAID = 2

• UNCOLLECTIBLE = 3

• VOID = 4

• string say = 1

Used in: CreatePlanResponse, FindPlansResponse, ReadPlanResponse

• string id = 1

  @inject_tag: bson:"_id,omitempty"

• string normalizedName = 2

  @inject_tag: bson:"normalizedName,omitempty"

• optional Price price = 3

  @inject_tag: bson:"prices,omitempty"

• repeated Feature features = 4

  @inject_tag: bson:"features,omitempty"

• bool active = 5

  @inject_tag: bson:"active,omitempty"

• bool free = 6

  @inject_tag: bson:"free,omitempty"

• string createdAt = 7

  @inject_tag: bson:"createdAt,omitempty"

• string updatedAt = 8

  @inject_tag: bson:"updatedAt,omitempty"

• string name = 9

  @inject_tag: bson:"name,omitempty"

• string stripeId = 10

  @inject_tag: bson:"stripeId,omitempty"

• MONTH = 0

• YEAR = 1

• WEEK = 2

• DAY = 3

Used in: Plan

• string name = 1

  @inject_tag: bson:"name,omitempty"

• string currency = 2

  @inject_tag: bson:"currency,omitempty"

• string id = 3

  @inject_tag: bson:"id,omitempty"

• int32 trialDays = 4

  @inject_tag: bson:"trialDays,omitempty"

• float amount = 5

  @inject_tag: bson:"amount,omitempty"

Used in: FindStripePlansResponse, ReadStripePlanResponse

• string name = 1

  @inject_tag: bson:"name,omitempty"

• string currency = 2

  @inject_tag: bson:"currency,omitempty"

• string id = 3

  @inject_tag: bson:"id,omitempty"

• int32 trialDays = 4

  @inject_tag: bson:"trialDays,omitempty"

• float amount = 5

  @inject_tag: bson:"amount,omitempty"

• ACTIVE = 0

• ALL = 1

• CANCELED = 2

• INCOMPLETE = 3

• INCOMPLETE_EXPIRED = 4

• PAST_DUE = 5

• TRIALING = 6

• UNPAID = 7

Used in: CancelSubscriptionResponse, ChangeSubscriptionResponse, CreateSubscriptionResponse, FindSubscriptionsResponse, ReadSubscriptionResponse

• string id = 1

  @inject_tag: bson:"_id,omitempty"

• string tenantId = 2

  @inject_tag: bson:"tenantId,omitempty"

• string status = 3

  @inject_tag: bson:"status,omitempty"

• string createdAt = 6

  @inject_tag: bson:"createdAt,omitempty"

• string updatedAt = 7

  @inject_tag: bson:"updatedAt,omitempty"

• string collectionMethod = 8

  @inject_tag: bson:"collectionMethod,omitempty"

• string currentPeriodStart = 9

• string currentPeriodEnd = 10

• string endedAt = 11

• string canceledAt = 12

• string latestInvoiceId = 13

• string startDate = 14

• string trialStart = 15

• string trialEnd = 16

• string customerEmail = 17

• string customerName = 18