Package com.stripe.param.billing

Class CreditGrantCreateParams

java.lang.Object
com.stripe.net.ApiRequestParams
com.stripe.param.billing.CreditGrantCreateParams
public class CreditGrantCreateParams extends ApiRequestParams

  • Method Details

    • builder

      public static CreditGrantCreateParams.Builder builder()

    • getAmount

      public CreditGrantCreateParams.Amount getAmount()
      Required. Amount of this credit grant.

    • getApplicabilityConfig

      public CreditGrantCreateParams.ApplicabilityConfig getApplicabilityConfig()
      Required. Configuration specifying what this credit grant applies to. We currently only support metered prices that have a Billing Meter attached to them.

    • getCategory

      public CreditGrantCreateParams.Category getCategory()
      Required. The category of this credit grant.

    • getCustomer

      public String getCustomer()
      Required. ID of the customer to receive the billing credits.

    • getEffectiveAt

      public Long getEffectiveAt()
      The time when the billing credits become effective-when they're eligible for use. It defaults to the current timestamp if not specified.

    • getExpand

      public List<String> getExpand()
      Specifies which fields in the response should be expanded.

    • getExpiresAt

      public Long getExpiresAt()
      The time when the billing credits expire. If not specified, the billing credits don't expire.

    • getExtraParams

      public Map<String,Object> getExtraParams()
      Map of extra parameters for custom features not available in this client library. The content in this map is not serialized under this field's @SerializedName value. Instead, each key/value pair is serialized as if the key is a root-level field (serialized) name in this param object. Effectively, this map is flattened to its parent instance.

    • getMetadata

      public Map<String,String> getMetadata()
      Set of key-value pairs that you can attach to an object. You can use this to store additional information about the object (for example, cost basis) in a structured format.

    • getName

      public String getName()
      A descriptive name shown in the Dashboard.

    • getPriority

      public Long getPriority()
      The desired priority for applying this credit grant. If not specified, it will be set to the default value of 50. The highest priority is 0 and the lowest is 100.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object