Package com.stripe.param

Class SubscriptionListParams.Builder

java.lang.Object
com.stripe.param.SubscriptionListParams.Builder
Enclosing class:
SubscriptionListParams
public static class SubscriptionListParams.Builder extends Object

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • build

      public SubscriptionListParams build()
      Finalize and obtain parameter instance from this builder.

    • setAutomaticTax

      public SubscriptionListParams.Builder setAutomaticTax(SubscriptionListParams.AutomaticTax automaticTax)
      Filter subscriptions by their automatic tax settings.

    • setCollectionMethod

      public SubscriptionListParams.Builder setCollectionMethod(SubscriptionListParams.CollectionMethod collectionMethod)
      The collection method of the subscriptions to retrieve. Either charge_automatically or send_invoice.

    • setCreated

      public SubscriptionListParams.Builder setCreated(SubscriptionListParams.Created created)
      Only return subscriptions that were created during the given date interval.

    • setCreated

      public SubscriptionListParams.Builder setCreated(Long created)
      Only return subscriptions that were created during the given date interval.

    • setCurrentPeriodEnd

      public SubscriptionListParams.Builder setCurrentPeriodEnd(SubscriptionListParams.CurrentPeriodEnd currentPeriodEnd)

    • setCurrentPeriodEnd

      public SubscriptionListParams.Builder setCurrentPeriodEnd(Long currentPeriodEnd)

    • setCurrentPeriodStart

      public SubscriptionListParams.Builder setCurrentPeriodStart(SubscriptionListParams.CurrentPeriodStart currentPeriodStart)

    • setCurrentPeriodStart

      public SubscriptionListParams.Builder setCurrentPeriodStart(Long currentPeriodStart)

    • setCustomer

      public SubscriptionListParams.Builder setCustomer(String customer)
      The ID of the customer whose subscriptions will be retrieved.

    • setEndingBefore

      public SubscriptionListParams.Builder setEndingBefore(String endingBefore)
      A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.

    • addExpand

      public SubscriptionListParams.Builder addExpand(String element)
      Add an element to `expand` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See SubscriptionListParams.expand for the field documentation.

    • addAllExpand

      public SubscriptionListParams.Builder addAllExpand(List<String> elements)
      Add all elements to `expand` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See SubscriptionListParams.expand for the field documentation.

    • putExtraParam

      public SubscriptionListParams.Builder putExtraParam(String key, Object value)
      Add a key/value pair to `extraParams` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See SubscriptionListParams.extraParams for the field documentation.

    • putAllExtraParam

      public SubscriptionListParams.Builder putAllExtraParam(Map<String,Object> map)
      Add all map key/value pairs to `extraParams` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See SubscriptionListParams.extraParams for the field documentation.

    • setLimit

      public SubscriptionListParams.Builder setLimit(Long limit)
      A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

    • setPlan

      public SubscriptionListParams.Builder setPlan(String plan)
      The ID of the plan whose subscriptions will be retrieved.

    • setPrice

      public SubscriptionListParams.Builder setPrice(String price)
      Filter for subscriptions that contain this recurring price ID.

    • setStartingAfter

      public SubscriptionListParams.Builder setStartingAfter(String startingAfter)
      A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

    • setStatus

      public SubscriptionListParams.Builder setStatus(SubscriptionListParams.Status status)
      The status of the subscriptions to retrieve. Passing in a value of canceled will return all canceled subscriptions, including those belonging to deleted customers. Pass ended to find subscriptions that are canceled and subscriptions that are expired due to incomplete payment. Passing in a value of all will return subscriptions of all statuses. If no value is supplied, all subscriptions that have not been canceled are returned.

    • setTestClock

      public SubscriptionListParams.Builder setTestClock(String testClock)
      Filter for subscriptions that are associated with the specified test clock. The response will not include subscriptions with test clocks if this and the customer parameter is not set.